openpectus.aggregator.frontend_publisher

Classes

PubSubTopic	Enum where members are also (and must be) strings
FrontendPublisher

Module Contents

class openpectus.aggregator.frontend_publisher.PubSubTopic

Bases: enum.StrEnum

Enum where members are also (and must be) strings

RUN_LOG

METHOD

METHOD_STATE

CONTROL_STATE

ERROR_LOG

PROCESS_UNITS

ACTIVE_USERS

DEAD_MAN_SWITCH

class openpectus.aggregator.frontend_publisher.FrontendPublisher

router

on_disconnect_callbacks: list[Callable[[str], Awaitable[None]]] = []

pubsub_endpoint

__str__()

Return type:

str

async publish_process_units_changed()

async publish_run_log_changed(unitId)

Parameters:

unitId (str)

async publish_method_changed(unitId)

Parameters:

unitId (str)

async publish_method_state_changed(unitId)

Parameters:

unitId (str)

async publish_control_state_changed(unitId)

Parameters:

unitId (str)

async publish_error_log_changed(unitId)

Parameters:

unitId (str)

async publish_active_users_changed(unitId)

Parameters:

unitId (str)

expose_pubsub_topics(topic)

This endpoint is just for exposing the topic enum to frontend via automatic type generation

Parameters:

topic (PubSubTopic)

async trigger_publish_msw()

Publish to all topics that start with ‘MSW_’

async on_disconnect(rpc_channel)

Parameters:

rpc_channel (fastapi_websocket_rpc.rpc_channel.RpcChannel)

register_on_disconnect(on_disconnect)

Parameters:

on_disconnect (Callable[[str], Awaitable[None]])