orionis.realtime.ConnectionManager

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class ConnectionManager(IConnectionManager): (source)

Constructor: ConnectionManager(config)

View In Hierarchy

Own worker-local connections and isolate every group by Hub class.

Registry mutations contain no await points and run on the application's event loop. Delivery snapshots identifiers before awaiting network I/O. Replacing IConnectionManager is the extension point for distributed delivery; the default registry never crosses process or worker boundaries.

Method	`__init__`	Initialize an empty registry with validated structural limits.
Async Method	`broadcast`	Encode once per codec and deliver through bounded concurrent workers.
Method	`connectionIds`	Snapshot ready connection identifiers in one Hub namespace.
Method	`get`	Look up a ready recipient without crossing an optional Hub boundary.
Method	`groupIds`	Snapshot ready group members without crossing Hub namespaces.
Method	`hub`	Return application-service client targets for a Hub namespace.
Method	`join`	Join an active or provisional connection to a bounded group set.
Method	`leave`	Remove membership idempotently and discard empty group entries.
Method	`register`	Own one provisional connection before its onConnect hook.
Method	`snapshot`	Snapshot all owned connections for bounded lifecycle shutdown.
Method	`unregister`	Release owned registry entries and every group reference.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_config`	Undocumented
Instance Variable	`_connections`	Undocumented
Instance Variable	`_groups`	Undocumented
Instance Variable	`_hubs`	Undocumented
Instance Variable	`_memberships`	Undocumented
Property	`config`	Return the immutable application limits used by Hub lifecycles.
Property	`connectionCount`	Return the number of owned, including provisional, connections.
Property	`groupCount`	Return the number of nonempty Hub-local groups.

def __init__(self, config: RealtimeConfig): (source) ¶

Initialize an empty registry with validated structural limits.

Parameters
config:`RealtimeConfig`	Group and broadcast limits shared by this application.

Returns
`None`	Store limits and initialize empty connection and membership maps.

async def broadcast(self, hub: type[Hub], connection_ids: tuple[str, ...], envelope: object) -> BroadcastResult: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.broadcast

Encode once per codec and deliver through bounded concurrent workers.

Parameters
hub:`type[Hub]`	Hub namespace restricting every recipient.
connection_ids:`tuple[str, ...]`	Recipient identifiers selected by the application.
envelope:`object`	Typed or mapping envelope accepted by the selected Hub codecs.

Returns
`BroadcastResult`	Successful and failed recipient counts; cancellation propagates.

Raises
`TypeError, ValueError`	If the payload cannot be encoded before delivery begins.

def connectionIds(self, hub: type[Hub]) -> tuple[str, ...]: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.connectionIds

Snapshot ready connection identifiers in one Hub namespace.

Parameters
hub:`type[Hub]`	Owning Hub class.

Returns
`tuple[str, ...]`	Current ready recipients; no connection objects are retained.

def get(self, connection_id: str, hub: type[Hub] | None = None) -> RealtimeConnectionLike | None: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.get

Look up a ready recipient without crossing an optional Hub boundary.

Parameters
connection_id:`str`	Identifier of the requested connection.
hub:`type[Hub] \| None, optional`	Required owning Hub class, or None to omit namespace filtering.

Returns
`RealtimeConnectionLike \| None`	Ready, nonclosing connection in the requested namespace, or None.

def groupIds(self, hub: type[Hub], group: str) -> tuple[str, ...]: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.groupIds

Snapshot ready group members without crossing Hub namespaces.

Parameters
hub:`type[Hub]`	Owning Hub class.
group:`str`	Group name within that Hub.

Returns
`tuple[str, ...]`	Current ready recipients of the named group.

Raises
`ValueError`	If the group name is invalid.

def hub(self, hub: type[Hub]) -> HubClients: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.hub

Return application-service client targets for a Hub namespace.

Parameters
hub:`type[Hub]`	Hub class whose clients should receive events or invocations.

Returns
`HubClients`	Client selectors without a connection-specific caller.

Raises
`TypeError`	If the supplied class is not a Hub subclass.

def join(self, connection_id: str, group: str): (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.join

Join an active or provisional connection to a bounded group set.

Parameters
connection_id:`str`	Owned connection, including one in its onConnect hook.
group:`str`	Hub-local group name, at most 256 characters.

Returns
`None`	Add membership without consuming another slot for repeated joins.

Raises
`ValueError`	If the group name is invalid.
`ConnectionError`	If this connection is absent or closing.
`RuntimeError`	If joining another group would exceed its configured limit.

def leave(self, connection_id: str, group: str): (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.leave

Remove membership idempotently and discard empty group entries.

Parameters
connection_id:`str`	Connection whose membership is being released.
group:`str`	Hub-local group name.

Returns
`None`	Remove the membership if still owned.

Raises
`ValueError`	If the group name is invalid.

def register(self, connection: RealtimeConnectionLike): (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.register

Own one provisional connection before its onConnect hook.

Parameters
connection:`RealtimeConnectionLike`	Connection with a cryptographically generated unique identifier.

Returns
`None`	Register the connection, its Hub namespace and empty memberships.

Raises
`ValueError`	If its identifier is invalid or already belongs to a connection.

def snapshot(self) -> tuple[RealtimeConnectionLike, ...]: (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.snapshot

Snapshot all owned connections for bounded lifecycle shutdown.

Returns
`tuple[RealtimeConnectionLike, ...]`	Active and provisional connections owned at the time of the call.

def unregister(self, connection: RealtimeConnectionLike): (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.unregister

Release owned registry entries and every group reference.

Parameters
connection:`RealtimeConnectionLike`	Exact connection instance to release; repeated release is harmless.

Returns
`None`	Remove ownership without touching an instance that reused an ID.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.__slots__

Undocumented

_config = (source) ¶

Undocumented

_connections: dict[str, RealtimeConnectionLike] = (source) ¶

Undocumented

_groups: dict[tuple[type[Hub], str], set[str]] = (source) ¶

Undocumented

_hubs: dict[type[Hub], set[str]] = (source) ¶

Undocumented

_memberships: dict[str, set[str]] = (source) ¶

Undocumented

@property

config: RealtimeConfig = (source) ¶

overrides orionis.realtime.contracts.IConnectionManager.config

Return the immutable application limits used by Hub lifecycles.

Returns
`RealtimeConfig`	Application-wide invocation, group and broadcast limits.

@property

connectionCount: int = (source) ¶

Return the number of owned, including provisional, connections.

Returns
`int`	Number of registered connections regardless of readiness.

@property

groupCount: int = (source) ¶

Return the number of nonempty Hub-local groups.

Returns
`int`	Number of groups with at least one registered member.