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.

Explore modules View classes

orionis.realtime.protocol

module documentation
(source)

Undocumented

Class Cancel Cancel one active client-to-server invocation.
Class Completion Finish a pending server-to-client call with exactly one result or error.
Class Invoke Request one named server operation within a bounded invocation lifetime.
Class Ping Request an application-level pong without creating a heartbeat task.
Class Pong Acknowledge an application-level ping.
Class RPCErrorPayload Carry the public error returned by one completed invocation.
Function _validate_completion Require exactly one completion outcome and bounded public error text.
Function _validate_invoke Validate structural request limits beyond the decoded envelope types.
Function validate_invocation_id Require a bounded printable identifier without interpreting its content.
Constant _DEFAULT_MESSAGE_LIMIT Undocumented
Constant MAX_ARGUMENTS Undocumented
Constant MAX_ERROR_CODE_LENGTH Undocumented
Constant MAX_ERROR_MESSAGE_LENGTH Undocumented
Constant MAX_ID_LENGTH Undocumented
def _validate_completion(message: Completion): (source)

Require exactly one completion outcome and bounded public error text.

Parameters
message:CompletionTyped client response.
Returns
NoneAccept one outcome including an explicit null result.
Raises
ProtocolErrorIf the identifier, outcome or public error fields are invalid.
def _validate_invoke(message: Invoke): (source)

Validate structural request limits beyond the decoded envelope types.

Parameters
message:InvokeTyped incoming invocation.
Returns
NoneAccept bounded names, arguments and an optional positive timeout.
Raises
ProtocolErrorIf an invocation exceeds a structural limit.
def validate_invocation_id(value: str): (source)

Require a bounded printable identifier without interpreting its content.

Parameters
value:strClient or server invocation identifier.
Returns
NoneAccept the opaque identifier.
Raises
ProtocolErrorIf the identifier is empty, oversized, non-ASCII or contains spaces or nonprintable characters.
_DEFAULT_MESSAGE_LIMIT = (source)

Undocumented

Value
1024 * 1024
MAX_ARGUMENTS: int = (source)

Undocumented

Value
64
MAX_ERROR_CODE_LENGTH: int = (source)

Undocumented

Value
64
MAX_ERROR_MESSAGE_LENGTH: int = (source)

Undocumented

Value
1024
MAX_ID_LENGTH: int = (source)

Undocumented

Value
128