orionis.queues.drivers.sync.SyncQueueDriver

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 SyncQueueDriver(IQueueDriver): (source)

Constructor: SyncQueueDriver(app, serializer, connection, failed_resolver, ...)

View In Hierarchy

Execute one immediate attempt through the shared worker pipeline.

Method	`__init__`	Prepare immediate execution without a durable backend.
Async Method	`clear`	Return zero removed jobs for an immediate channel.
Async Method	`close`	Signal the worker to stop without closing application services.
Async Method	`delete`	Acknowledge completion of an immediate execution.
Async Method	`push`	Execute the job immediately and propagate its original exception.
Async Method	`release`	Reject persistent retry on an immediate connection.
Async Method	`reserve`	Return no durable work for an immediate connection.
Async Method	`size`	Return the empty durable size of an immediate channel.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_retry_after`	Undocumented
Instance Variable	`_serializer`	Undocumented
Instance Variable	`_worker`	Undocumented

def __init__(self, app: IApplication, serializer: IJobSerializer, connection: str, failed_resolver: FailedResolver, retry_after: float = 90.0): (source) ¶

Prepare immediate execution without a durable backend.

Parameters
app:`IApplication`	Existing application container.
serializer:`IJobSerializer`	Registered job serializer.
connection:`str`	Logical connection name.
failed_resolver:`FailedResolver`	Resolver called only on terminal failure.
retry_after:`float, optional`	Execution lease used by the shared pipeline.

Returns
`None`	Complete the documented operation without returning a value.

async def clear(self, queue: str) -> int: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.clear

Return zero removed jobs for an immediate channel.

Parameters
queue:`str`	Unused channel name.

Returns
`int`	Zero, because no jobs are persisted.

async def close(self): (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.close

Signal the worker to stop without closing application services.

Returns
`None`	Set the stop signal without waiting for running jobs.

async def delete(self, reserved: ReservedJob) -> bool: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.delete

Acknowledge completion of an immediate execution.

Parameters
reserved:`ReservedJob`	Unused immediate reservation.

Returns
`bool`	Always true for the in-process execution.

async def push(self, envelope: JobEnvelope, delay: float = 0.0) -> str: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.push

Execute the job immediately and propagate its original exception.

Parameters
envelope:`JobEnvelope`	Immutable job payload and execution settings.
delay:`float, optional`	Delay, which must be zero for immediate execution.

Returns
`str`	Completed dispatch identifier.

Raises
`QueueDispatchError`	If delayed execution is requested.

async def release(self, reserved: ReservedJob, delay: float = 0.0) -> bool: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.release

Reject persistent retry on an immediate connection.

Parameters
reserved:`ReservedJob`	Unused immediate reservation.
delay:`float, optional`	Requested retry delay.

Returns
`bool`	Result of the operation described above.

Raises
`QueueDispatchError`	Always, because immediate jobs have no durable storage.

async def reserve(self, queues: tuple[str, ...], retry_after: float) -> ReservedJob | None: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.reserve

Return no durable work for an immediate connection.

Parameters
queues:`tuple[str, ...]`	Unused channel selection.
retry_after:`float`	Unused lease lifetime.

Returns
`None`	Immediate jobs are executed during push.

async def size(self, queue: str) -> int: (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.size

Return the empty durable size of an immediate channel.

Parameters
queue:`str`	Unused channel name.

Returns
`int`	Zero, because no jobs are persisted.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.queues.contracts.driver.IQueueDriver.__slots__

Undocumented

_retry_after = (source) ¶

Undocumented

_serializer = (source) ¶

Undocumented

_worker = (source) ¶

Undocumented