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.queues.PendingDispatch

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__ Undocumented
Instance Variable _completion Undocumented
Instance Variable _connection Undocumented
Instance Variable _delay Undocumented
Instance Variable _job Undocumented
Instance Variable _queue Undocumented
Instance Variable _submit Undocumented
def __await__(self) -> Generator[object, None, str]: (source)

Start or join the deferred dispatch when awaited.

Returns
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:DispatchCallbackManager entry point invoked only when awaited.
job: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
PendingDispatchThis pending operation.
def onConnection(self, name: str) -> PendingDispatch: (source)

Select the configured backend before submission.

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

Select a logical channel before submission.

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

Undocumented

_completion: asyncio.Future[str] | None = (source)

Undocumented

_connection: str | None = (source)

Undocumented

_delay = (source)

Undocumented

_job: BaseJob | None = (source)

Undocumented

_queue: str | None = (source)

Undocumented

_submit = (source)

Undocumented