pip_services3_commons.commands.IEventListener module

pip_services3_commons.commands.IEventListener

Interface for event_name listeners.

copyright

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

license

MIT, see LICENSE for more details.

class pip_services3_commons.commands.IEventListener.IEventListener

Bases: abc.ABC

An interface for listener objects that receive notifications on fired events.

Example:

class MyListener(IEventListener):
    def on_event(self, correlation_id, event_name, args):
        print "Fired event_name " + event_name.get_name()

event = Event("myevent")
event.addListener(MyListener())
event.notify("123", Parameters.from_tuples("param1", "ABC"))
on_event(correlation_id: Optional[str, None], event: <module 'pip_services3_commons.commands.IEvent' from '/pip_services3_commons/commands/IEvent.py'>, value: pip_services3_commons.run.Parameters.Parameters)

A method called when events this listener is subscrubed to are fired.

Parameters

  • correlation_id – (optional) transaction id to trace execution through call chain.

  • event – event_name reference

  • value – event_name arguments