Skip to main content

LocalEventManager

Local event manager for emitting system info events.

Hierarchy

Index

Methods

Methods

__aenter__

  • 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

    • optionalkeyword-onlyexc_type: type[BaseException] | None
    • optionalkeyword-onlyexc_value: BaseException | None
    • optionalkeyword-onlyexc_traceback: TracebackType | None

    Returns None

__init__

  • __init__(*, system_info_interval, event_manager_options): None

  • 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

  • emit(*, event, event_data): None

  • Emit an event.

    Parameters

    • optionalkeyword-onlyevent: Event

      The event which will be emitted.

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

    • optionalkeyword-onlyevent: Event

      The Actor event for which to remove listeners.

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

    • optionalkeyword-onlyevent: Event

      The Actor event for which to listen to.

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

    • 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

Page Options