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
Provide realtime operations.
Includes RPCErrorPayload, Invoke, Completion, Cancel.
| Class | |
Cancel one active client-to-server invocation. |
| Class | |
Finish a pending server-to-client call with exactly one result or error. |
| Class | |
Request one named server operation within a bounded invocation lifetime. |
| Class | |
Request an application-level pong without creating a heartbeat task. |
| Class | |
Acknowledge an application-level ping. |
| Class | |
Carry the public error returned by one completed invocation. |
| Function | _validate |
Require exactly one completion outcome and bounded public error text. |
| Function | _validate |
Validate structural request limits beyond the decoded envelope types. |
| Function | validate |
Require a bounded printable identifier without interpreting its content. |
| Constant | _DEFAULT |
Default message limit used by protocol. |
| Constant | MAX |
Max arguments value used by protocol. |
| Constant | MAX |
Max error code length value used by protocol. |
| Constant | MAX |
Max error message length value used by protocol. |
| Constant | MAX |
Max id length value used by protocol. |
| Type Alias | |
Type alias for Invoke | Completion | Cancel | Ping | Pong. |
Require exactly one completion outcome and bounded public error text.
| Parameters | |
message:orionis.realtime.protocol.Completion | Typed client response. |
| Returns | |
None | Accept one outcome including an explicit null result. |
| Raises | |
orionis.realtime.errors.ProtocolError | If the identifier, outcome or public error fields are invalid. |
Validate structural request limits beyond the decoded envelope types.
| Parameters | |
message:orionis.realtime.protocol.Invoke | Typed incoming invocation. |
| Returns | |
None | Accept bounded names, arguments and an optional positive timeout. |
| Raises | |
orionis.realtime.errors.ProtocolError | If an invocation exceeds a structural limit. |
Require a bounded printable identifier without interpreting its content.
| Parameters | |
value:str | Client or server invocation identifier. |
| Returns | |
None | Accept the opaque identifier. |
| Raises | |
orionis.realtime.errors.ProtocolError | If the identifier is empty, oversized, non-ASCII or contains spaces or nonprintable characters. |
Type alias for Invoke | Completion | Cancel | Ping | Pong.
| Value |
|