orionis.realtime.HubGroups

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

class HubGroups: (source)

Manage group membership owned by the current Hub connection.

Method	`__init__`	Bind membership operations to one owned connection.
Async Method	`join`	Join a group without consuming another slot for existing membership.
Async Method	`leave`	Remove the current connection from one group idempotently.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_connection_id`	Undocumented
Instance Variable	`_manager`	Undocumented

def __init__(self, manager: IConnectionManager, connection_id: str): (source) ¶

Bind membership operations to one owned connection.

Parameters
manager:`IConnectionManager`	Registry owning this connection and its Hub namespace.
connection_id:`str`	Current connection identifier.

Returns
`None`	Store the registry and connection identifier for membership changes.

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

Join a group without consuming another slot for existing membership.

Parameters
group:`str`	Hub-local group name, at most 256 characters.

Returns
`None`	Add the current connection, subject to its configured group limit.

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

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

Remove the current connection from one group idempotently.

Parameters
group:`str`	Hub-local group name.

Returns
`None`	Remove membership and discard groups with no remaining members.

Raises
`ValueError`	If the group name is invalid.

Undocumented

Undocumented

Undocumented