pip_services3_commons.commands.IEvent module

pip_services3_commons.commands.IEvent

Interface for events.

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_commons.commands.IEvent.IEvent

Bases: pip_services3_commons.run.INotifiable.INotifiable

An interface for Events, which are part of the Command design pattern. Events allows to send asynchronious notifications to multiple subscribed listeners.

add_listener(listener: pip_services3_commons.commands.IEventListener.IEventListener)

Adds listener to receive notifications

Parameters

listener – a listener reference to be added

get_listeners() → List[pip_services3_commons.commands.IEventListener.IEventListener]

Get listeners that receive notifications for that event_name

Returns

a list with listeners

get_name() → str

Gets the event_name name.

Returns

the event_name name

remove_listener(listener: pip_services3_commons.commands.IEventListener.IEventListener)

Removes listener for event_name notifications.

Parameters

listener – a listener reference to be removed