| Variables: |
- channels –
an optional attribute that may be set before firing
the event. If defined (usually as a class variable), the attribute
specifies the channels that the event should be delivered
to as a tuple. This overrides the default behavior
of sending the event to the firing component’s channel.
When an event is fired, the value in this attribute
is replaced for the instance with the channels that
the event is actually sent to. This information may be used
e.g. when the event is passed as a parameter to a handler.
- value – this is a circuits.core.values.Value
object that holds the results returned by the handlers invoked
for the event.
- success – if this optional attribute is set to
True, an associated event success (original name
with “_success” appended) will automatically be fired when all
handlers for the event have been invoked successfully.
- success_channels – the success event is, by default, delivered
to same channels as the successfully dispatched event itself.
This may be overridden by specifying an alternative list of
destinations using this attribute.
- complete – if this optional attribute is set to
True, an associated event complete (original name
with “_complete” appended) will automatically be fired when all
handlers for the event and all events fired by these handlers
(recursively) have been invoked successfully.
- complete_channels – the complete event is, by default, delivered
to same channels as the initially dispatched event itself.
This may be overridden by specifying an alternative list of
destinations using this attribute.
|
|---|