orionis.queues.contracts.manager.IQueueManager

ORIONIS API REFERENCE

Modules Classes Names

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

class documentation

class IQueueManager(ABC): (source)

Known subclasses: orionis.queues.manager.QueueManager

View In Hierarchy

Declare the canonical dispatch and queue administration API.

Async Method	`close`	Close queue-owned clients without disposing shared database services.
Async Method	`connection`	Resolve a configured connection lazily.
Method	`dispatch`	Create an awaitable operation without performing I/O.
Async Method	`failed`	Resolve the durable failure repository lazily.
Async Method	`retryFailed`	Requeue a failed job with a fresh attempt budget.
Async Method	`worker`	Create a worker using validated central settings.
Class Variable	`__slots__`	Undocumented

@abstractmethod

async def close(self): (source) ¶

overridden in orionis.queues.manager.QueueManager

Close queue-owned clients without disposing shared database services.

Returns
`None`	Release resources owned by queue drivers.

@abstractmethod

async def connection(self, name: str | None = None) -> IQueueDriver: (source) ¶

overridden in orionis.queues.manager.QueueManager

Resolve a configured connection lazily.

Parameters
name:`str \| None, optional`	Connection name, or the central default.

Returns
`IQueueDriver`	Driver shared by logical queues on this connection.

@abstractmethod

def dispatch(self, job: BaseJob) -> PendingDispatch: (source) ¶

overridden in orionis.queues.manager.QueueManager

Create an awaitable operation without performing I/O.

Parameters
job:`BaseJob`	Serializable application job.

Returns
`PendingDispatch`	Deferred operation with fluent selection and delay.

@abstractmethod

async def failed(self) -> IFailedJobRepository: (source) ¶

overridden in orionis.queues.manager.QueueManager

Resolve the durable failure repository lazily.

Returns
`IFailedJobRepository`	Central repository shared by connections.

@abstractmethod

async def retryFailed(self, failed_id: str) -> str: (source) ¶

overridden in orionis.queues.manager.QueueManager

Requeue a failed job with a fresh attempt budget.

Parameters
failed_id:`str`	Failure identifier to retry.

Returns
`str`	Identifier returned by persistent dispatch.

@abstractmethod

async def worker(self, connection: str | None = None, queues: tuple[str, ...] | None = None, concurrency: int | None = None) -> IWorker: (source) ¶

overridden in orionis.queues.manager.QueueManager

Create a worker using validated central settings.

Parameters
connection:`str \| None, optional`	Backend name, or the default.
queues:`tuple[str, ...] \| None, optional`	Priority-ordered channels, or the connection default.
concurrency:`int \| None, optional`	Maximum simultaneous attempts, or the worker default.

Returns
`IWorker`	Independent worker runtime.

__slots__: tuple = (source) ¶

overridden in orionis.queues.manager.QueueManager

Undocumented