ORIONIS API REFERENCE

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.

class documentation

Share one immutable encoded payload per codec among bounded workers.

Method __init__ Share recipient iteration, encoded frames, and counters across workers.
Async Method run Drain the shared recipient iterator and count per-connection outcomes.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable encoded Immutable frame payloads, encoded once per selected codec.
Instance Variable failed Failed value used by _Broadcast.
Instance Variable hub Hub namespace restricting all recipients.
Instance Variable manager Registry used to recheck availability immediately before sending.
Instance Variable recipients Snapshot of recipient identifiers; no connections are retained.
Instance Variable sent Sent value used by _Broadcast.
def __init__(self, manager: IConnectionManager, hub: type[Hub], recipients: tuple[str, ...], encoded: dict[str, str | bytes]): (source)

Share recipient iteration, encoded frames, and counters across workers.

Parameters
manager:orionis.realtime.contracts.manager.IConnectionManagerRegistry used to recheck recipient availability before each send.
hub:type[orionis.realtime.Hub]Hub namespace that every recipient must belong to.
recipients:tuple[str, ...]Recipient identifier snapshot shared by all delivery workers.
encoded:dict[str, str | bytes]Frame values shared across workers, encoded once per selected codec.
Returns
NoneRetain delivery inputs and initialize shared sent/failed counters.
async def run(self): (source)

Drain the shared recipient iterator and count per-connection outcomes.

Returns
NoneCount completed sends and failed or unavailable recipients, continuing after ordinary delivery exceptions.
Raises
asyncio.CancelledErrorIf the worker is cancelled; retain counts for completed recipients.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

Immutable frame payloads, encoded once per selected codec.

Failed value used by _Broadcast.

Hub namespace restricting all recipients.

Registry used to recheck availability immediately before sending.

recipients = (source)

Snapshot of recipient identifiers; no connections are retained.

Sent value used by _Broadcast.