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.contracts.driver.IQueueDriver

class documentation

class IQueueDriver(ABC): (source)

Known subclasses: orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

View In Hierarchy

Declare persistence and fenced transitions for a queue connection.

Async Method clear Remove all stored jobs from a logical queue.
Async Method close Close resources owned by this driver.
Async Method delete Acknowledge a job only while its claim owns the lease.
Async Method push Persist an envelope until its scheduled availability.
Async Method release Release the current claim for a later attempt.
Async Method reserve Acquire one eligible job in queue priority order.
Async Method size Count ready, delayed, and reserved jobs in a logical queue.
Class Variable __slots__ Undocumented
async def clear(self, queue: str) -> int: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Remove all stored jobs from a logical queue.

Parameters
queue:strLogical channel.
Returns
intNumber of removed jobs, including active reservations.
async def close(self): (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Close resources owned by this driver.

Returns
NoneRelease driver-owned resources.
async def delete(self, reserved: ReservedJob) -> bool: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Acknowledge a job only while its claim owns the lease.

Parameters
reserved:ReservedJobCurrent claim.
Returns
boolWhether the fenced acknowledgement removed the job.
async def push(self, envelope: JobEnvelope, delay: float = 0) -> str: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Persist an envelope until its scheduled availability.

Parameters
envelope:JobEnvelopeImmutable execution data.
delay:float, optionalSeconds before the job becomes eligible.
Returns
strThe persisted job identifier.
async def release(self, reserved: ReservedJob, delay: float = 0) -> bool: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Release the current claim for a later attempt.

Parameters
reserved:ReservedJobClaim whose token must still own the lease.
delay:float, optionalSeconds before another reservation becomes eligible.
Returns
boolWhether the claim still owned an unexpired lease.
async def reserve(self, queues: tuple[str, ...], retry_after: float) -> ReservedJob | None: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Acquire one eligible job in queue priority order.

Parameters
queues:tuple[str, ...]Logical queues ordered from highest to lowest priority.
retry_after:floatDuration of the reservation lease.
Returns
ReservedJob | NoneThe exclusive claim, or no eligible job.
async def size(self, queue: str) -> int: (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Count ready, delayed, and reserved jobs in a logical queue.

Parameters
queue:strLogical channel.
Returns
intNumber of stored jobs.
__slots__: tuple = (source)
overridden in orionis.queues.drivers.database.DatabaseQueueDriver, orionis.queues.drivers.redis.RedisQueueDriver, orionis.queues.drivers.sync.SyncQueueDriver

Undocumented