LocalEventManager
Hierarchy
- EventManager
- LocalEventManager
Index
Methods
__aenter__
Initializes the local event manager upon entering the async context.
It starts emitting system info events at regular intervals.
Returns LocalEventManager
__aexit__
Closes the local event manager upon exiting the async context.
It stops emitting system info events and closes the event manager.
Parameters
optionalkeyword-onlyexc_type: type[BaseException] | None
optionalkeyword-onlyexc_value: BaseException | None
optionalkeyword-onlyexc_traceback: TracebackType | None
Returns None
__init__
A default constructor.
Parameters
optionalkeyword-onlysystem_info_interval: timedelta = timedelta(seconds=1)
Interval at which
SystemInfo
events are emitted.keyword-onlypersist_state_interval: timedelta
Interval between emitted
PersistState
events to maintain state persistence.keyword-onlyclose_timeout: timedelta | None
Optional timeout for canceling pending event listeners if they exceed this duration.
Returns None
emit
Parameters
optionalkeyword-onlyevent: Literal[Event.PERSIST_STATE]
optionalkeyword-onlyevent_data: EventPersistStateData
Returns None
on
Parameters
optionalkeyword-onlyevent: Literal[Event.PERSIST_STATE]
optionalkeyword-onlylistener: EventListener[EventPersistStateData]
Returns None
off
Remove a listener, or all listeners, from an Actor event.
Parameters
optionalkeyword-onlyevent: Event
The Actor event for which to remove listeners.
optionalkeyword-onlylistener: EventListener[Any] | None = None
The listener which is supposed to be removed. If not passed, all listeners of this event are removed.
Returns None
wait_for_all_listeners_to_complete
Wait for all currently executing event listeners to complete.
Parameters
optionalkeyword-onlytimeout: timedelta | None = None
The maximum time to wait for the event listeners to finish. If they do not complete within the specified timeout, they will be canceled.
Returns None
Properties
active
Indicates whether the context is active.
Local event manager for emitting system info events.