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 RealtimeConnectionLike(Protocol): (source)
Describe the connection surface required by the worker-local registry.
| Async Method | invoke |
Invoke one client method and await its correlated completion. |
| Async Method | send |
Send an encoded frame while preserving transport backpressure. |
| Class Variable | __slots__ |
Undocumented |
| Property | closing |
Report whether this connection is being released. |
| Property | context |
Return the immutable connection identity and handshake context. |
| Property | hub |
Return the Hub namespace owning this connection. |
| Property | protocol |
Return the immutable codec selected for this connection. |
| Property | ready |
Report whether acceptance has admitted ordered realtime delivery. |
async def invoke(self, target:
str, *args: object, timeout: float | None = None) -> object:
(source)
¶
Invoke one client method and await its correlated completion.
| Parameters | |
target:str | Explicit client method name. |
*args:object | Serializable positional arguments supplied to the client method. |
timeout:float | None, optional | Total send/result deadline in seconds. None uses the configured client-result timeout. |
| Returns | |
object | Client completion result, including None. |
| Raises | |
ConnectionError | If the connection is not ready or disconnects. |
RuntimeError | If the pending client-result budget is exhausted. |
ValueError | If the target, argument count or deadline is invalid. |
TimeoutError | If sending or receiving the completion exceeds the deadline. |
ClientInvocationError | If the client returns a completion error. |
Send an encoded frame while preserving transport backpressure.
| Parameters | |
data:str | bytes | Immutable, already encoded protocol envelope. |
| Returns | |
None | Complete the ordered transport write. |
| Raises | |
ConnectionError | If connection cleanup has started. |
Return the immutable connection identity and handshake context.
| Returns | |
HubContext | Connection identity, public socket and authenticated user. |
Return the immutable codec selected for this connection.
| Returns | |
HubProtocol | Route-selected codec for protocol envelopes. |