INotifiable

Interface that allows you to create components that can be asynchronously notified.

Description

The INotifiable interface allows you to create components that can be asynchronously notified.

Important points

  • The notification can include an optional argument that describes an occurred event.

Instance methods

notify

Notifies the component about an occured event.

notify(correlation_id: Optional[str], args: Parameters)

  • correlation_id: Optional[str] - (optional) transaction id to trace execution through the call chain.
  • args: Parameters - notification arguments.

Examples

class MyComponent(INotifable):
    ...
    def notify(correlationId, args): 
        print("Occured event " + args.get_as_string("event"))
    
   
my_component = MyComponent()
my_component.notify("123", Parameters.from_tuples("event", "Test Event"));

See also