orionis.realtime.clients

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.

module documentation

(source)

Undocumented

Class	`ClientTarget`	Send to a Hub-local selection or invoke one explicitly selected client.
Function	`_validate_call`	Validate a public client target and its argument count.
Function	`validate_group`	Validate a bounded, nonempty group name.
Function	`validate_identifier`	Validate a bounded, nonempty connection or public method identifier.
Constant	`_MAX_ARGUMENTS`	Undocumented
Constant	`_MAX_GROUP`	Undocumented
Constant	`_MAX_IDENTIFIER`	Undocumented

def _validate_call(target: str, args: tuple[object, ...]): (source) ¶

Validate a public client target and its argument count.

Parameters
target:`str`	Remote client method or event name.
args:`tuple[object, ...]`	Positional values to serialize.

Returns
`None`	Accept the public target and up to 64 positional arguments.

Raises
`ValueError`	If a target is private, qualified, oversized or has too many arguments.

def validate_group(group: str): (source) ¶

Validate a bounded, nonempty group name.

Parameters
group:`str`	Hub-local group name supplied by application code.

Returns
`None`	Accept the group name without modifying it.

Raises
`ValueError`	If the name is missing, non-string or longer than 256 characters.

def validate_identifier(value: str, label: str = 'Identifier'): (source) ¶

Validate a bounded, nonempty connection or public method identifier.

Parameters
value:`str`	Identifier supplied by application code.
label:`str, optional`	Description included in a validation error.

Returns
`None`	Accept the identifier without modifying it.

Raises
`ValueError`	If the identifier is missing, non-string or longer than 128 characters.

Undocumented

Value

Undocumented

Value

Undocumented

Value