pyfebiopt.monitoring.events

Socket helpers and envelopes for emitting monitor events.

Classes

`EventEmitter`	Abstract emitter interface for monitor events.
`NullEventEmitter`	Drop events without raising when the monitor is unavailable.
`SocketEventEmitter`	Emit monitor events through a UNIX domain socket.
`EventConsumer`	Protocol for objects that consume monitor events.
`EventSocketListener`	Listen for monitor events over a UNIX socket.

Return an emitter that targets the provided socket path.

class pyfebiopt.monitoring.events.EventEmitter

Abstract emitter interface for monitor events.

abstractmethod emit(job_id: str, event: str, payload: dict[str, Any]) → None: Send a single event payload for the given job.

class pyfebiopt.monitoring.events.NullEventEmitter

Drop events without raising when the monitor is unavailable.

emit(job_id: str, event: str, payload: dict[str, Any]) → None: Ignore the event entirely.

class pyfebiopt.monitoring.events.SocketEventEmitter(socket_path: pathlib.Path)

Emit monitor events through a UNIX domain socket.

Keep the socket path for future emission attempts.

emit(job_id: str, event: str, payload: dict[str, Any]) → None: Send the serialized envelope to the monitor.

pyfebiopt.monitoring.events.create_event_emitter(socket_path: pathlib.Path | None) → EventEmitter: Return an emitter that targets the provided socket path.

class pyfebiopt.monitoring.events.EventConsumer

Bases: Protocol

Protocol for objects that consume monitor events.

apply_event(job_id: str, event: str, payload: dict[str, Any], ts: float) → None

class pyfebiopt.monitoring.events.EventSocketListener(socket_path: pathlib.Path, consumer: EventConsumer)

Listen for monitor events over a UNIX socket.

Track the path and consumer for the incoming stream.