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.

class documentation

class PendingDispatch: (source)

Constructor: PendingDispatch(submit, job)

View In Hierarchy

Defer a single dispatch until awaited and allow options before submission.

Method __await__ Start or join the deferred dispatch when awaited.
Method __init__ Retain a job and its asynchronous submission callback.
Method _checkMutable Reject changes after the submission task has started.
Async Method _run Submit once and share the result with every awaiter.
Method delay Schedule availability relative to submission time.
Method onConnection Select the configured backend before submission.
Method onQueue Select a logical channel before submission.
Class Variable __slots__ Declare the instance attribute slots reserved by this class.
Instance Variable _completion Completion provider or result associated with the primitive.
Instance Variable _connection Configured connection used to store or dispatch the operation.
Instance Variable _delay Delay value used by PendingDispatch.
Instance Variable _job Instance whose declared data will be serialized on submission.
Instance Variable _queue Name of the queue receiving or storing the job.
Instance Variable _submit Manager entry point invoked only when awaited.
def __await__(self) -> Generator[object, None, str]: (source)

Start or join the deferred dispatch when awaited.

Returns
collections.abc.Generator[object, None, str]Iterator consumed by Python's await protocol.
def __init__(self, submit: DispatchCallback, job: BaseJob): (source)

Retain a job and its asynchronous submission callback.

Parameters
submit:orionis.queues.types.DispatchCallbackManager entry point invoked only when awaited.
job:orionis.queues.BaseJobInstance whose declared data will be serialized on submission.
Returns
NoneComplete the documented operation without returning a value.
def _checkMutable(self): (source)

Reject changes after the submission task has started.

Returns
NoneValidate the pending operation's state.
async def _run(self) -> str: (source)

Submit once and share the result with every awaiter.

Returns
strPersisted job identifier.
def delay(self, seconds: float) -> PendingDispatch: (source)

Schedule availability relative to submission time.

Parameters
seconds:floatFinite nonnegative delay.
Returns
orionis.queues.PendingDispatchThis pending operation.
def onConnection(self, name: str) -> PendingDispatch: (source)

Select the configured backend before submission.

Parameters
name:strConnection name from queue configuration.
Returns
orionis.queues.PendingDispatchThis pending operation.
def onQueue(self, name: str) -> PendingDispatch: (source)

Select a logical channel before submission.

Parameters
name:strChannel within the selected connection.
Returns
orionis.queues.PendingDispatchThis pending operation.
__slots__: tuple[str, ...] = (source)

Declare the instance attribute slots reserved by this class.

Completion provider or result associated with the primitive.

_connection: str | None = (source)

Configured connection used to store or dispatch the operation.

Delay value used by PendingDispatch.

Instance whose declared data will be serialized on submission.

Name of the queue receiving or storing the job.

Manager entry point invoked only when awaited.