LocalEventManager

Event manager for local environments.

It extends the EventManager to emit SystemInfo events at regular intervals. The LocalEventManager is intended to be used in local environments, where the system metrics are required managing the Snapshotter and AutoscaledPool.

Hierarchy

• EventManager
  • LocalEventManager

Index

Methods

• __aenter__
• __aexit__
• __init__
• emit
• from_config
• off
• on
• wait_for_all_listeners_to_complete

Properties

• active

Methods

__aenter__

• async __aenter__(): LocalEventManager

• Overrides EventManager.__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

• Overrides EventManager.__aexit__

  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

__init__

• __init__(system_info_interval, event_manager_options): None

• Overrides EventManager.__init__

  A default constructor.

  In most cases, you should use the from_config constructor to create a new instance based on the provided configuration.

  ---

  Parameters

  • optionalsystem_info_interval: timedelta = timedelta(seconds=1)

    Interval at which SystemInfo events are emitted.

  • keyword-onlyoptionalpersist_state_interval: timedelta

    Interval between emitted PersistState events to maintain state persistence.

  • keyword-onlyoptionalclose_timeout: timedelta | None

    Optional timeout for canceling pending event listeners if they exceed this duration.

  Returns None

emit

• emit(*: , event: Event, event_data: EventData): None
• emit(*: , event: Literal[Event.PERSIST_STATE], event_data: EventPersistStateData): None
• emit(*: , event: Literal[Event.SYSTEM_INFO], event_data: EventSystemInfoData): None
• emit(*: , event: Literal[Event.MIGRATING], event_data: EventMigratingData): None
• emit(*: , event: Literal[Event.ABORTING], event_data: EventAbortingData): None
• emit(*: , event: Literal[Event.EXIT], event_data: EventExitData): None
• emit(*: , event: Event, event_data: Any): None

• Inherited from EventManager.emit

  Emit an event with the associated data to all registered listeners.

  ---

  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

from_config

• from_config(config): LocalEventManager

• Create a new instance based on the provided Configuration.

  ---

  Parameters

  • optionalconfig: Configuration | None = None

    The Configuration instance. Uses the global (default) one if not provided.

  Returns LocalEventManager

off

• off(*, event, listener): None

• Inherited from EventManager.off

  Remove a specific listener or all listeners for an event.

  ---

  Parameters

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

on

• on(*: , event: Event, listener: EventListener[Any]): None
• on(*: , event: Literal[Event.PERSIST_STATE], listener: EventListener[EventPersistStateData]): None
• on(*: , event: Literal[Event.SYSTEM_INFO], listener: EventListener[EventSystemInfoData]): None
• on(*: , event: Literal[Event.MIGRATING], listener: EventListener[EventMigratingData]): None
• on(*: , event: Literal[Event.ABORTING], listener: EventListener[EventAbortingData]): None
• on(*: , event: Literal[Event.EXIT], listener: EventListener[EventExitData]): None
• on(*: , event: Event, listener: EventListener[None]): None

• Inherited from EventManager.on

  Register an event listener for a specific event.

  ---

  Parameters

  • keyword-onlyevent: Event

    The event for which to listen to.

  • keyword-onlylistener: EventListener[Any]

    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

• Inherited from EventManager.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

active: bool

Inherited from EventManager.active

Indicate whether the context is active.