LocalEventManager

Local event manager for emitting system info events.

Hierarchy

• EventManager
  • LocalEventManager

Index

Constructors

• __init__

Methods

• __aenter__
• __aexit__
• emit
• off
• on
• wait_for_all_listeners_to_complete

Constructors

__init__

• __init__(system_info_interval, event_manager_options): None

• Create a new instance.

  ---

  Parameters

  • system_info_interval: timedelta = timedelta(seconds=1)

    Interval at which SystemInfo events are emitted.

  • event_manager_options: Unpack[EventManagerOptions]

    Additional options for the parent class.

  Returns None

Methods

__aenter__

• async __aenter__(): LocalEventManager

• Initializes the local event manager upon entering the async context.

  It starts emitting system info events at regular intervals.

  ---

  Returns LocalEventManager

__aexit__

• async __aexit__(exc_type, exc_value, exc_traceback): None

• Closes the local event manager upon exiting the async context.

  It stops emitting system info events and closes the event manager.

  ---

  Parameters

  • exc_type: type[BaseException] | None

  • exc_value: BaseException | None

  • exc_traceback: TracebackType | None

  Returns None

emit

• emit(*, event, event_data): None

• Emit an event.

  ---

  Parameters

  • keyword-onlyevent: Event

    The event which will be emitted.

  • keyword-onlyevent_data: EventData

    The data which will be passed to the event listeners.

  Returns None

off

• off(*, event, listener): None

• Remove a listener, or all listeners, from an Actor event.

  ---

  Parameters

  • keyword-onlyevent: Event

    The Actor event for which to remove listeners.

  • keyword-onlylistener: Listener | None = None

    The listener which is supposed to be removed. If not passed, all listeners of this event are removed.

  Returns None

on

• on(*, event, listener): None

• Add an event listener to the event manager.

  ---

  Parameters

  • keyword-onlyevent: Event

    The Actor event for which to listen to.

  • keyword-onlylistener: Listener

    The function (sync or async) which is to be called when the event is emitted.

  Returns None

wait_for_all_listeners_to_complete

• async wait_for_all_listeners_to_complete(*, timeout): None

• Wait for all currently executing event listeners to complete.

  ---

  Parameters

  • keyword-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