PollableQueueDriverInterface

A queue driver with a persistent backlog that an out-of-process worker (queue:work, see QueueWorker) can poll.

Implemented by quioteframework/queue-db’s DbQueueDriver, deliberately not by SyncQueueDriver (nothing to poll).

Synopsis

interface PollableQueueDriverInterface extends QueueDriverInterface

Implements	QueueDriverInterface
Implemented by	DbQueueDriver, RedisQueueDriver
Source	PollableQueueDriverInterface.php

Methods

Method	Description
ack(ReservedJob $job): void	Mark a reserved job as successfully processed; removes it permanently.
discard(ReservedJob $job): void	Remove a reserved job permanently after retries are exhausted.
release(ReservedJob $job, int $delaySeconds): void	Return a reserved job to the backlog, available again after $delaySeconds.
reserve(): ?ReservedJob	Claim and return the next due job, or null if the queue is empty.

ack()

abstract public function ack(ReservedJob $job): void

Mark a reserved job as successfully processed; removes it permanently.

Parameter	Type	Description
$job	ReservedJob

discard()

abstract public function discard(ReservedJob $job): void

Remove a reserved job permanently after retries are exhausted.

Dead-letter recording itself already happened via FailedJobStoreInterface inside JobExecutor — this only stops the driver from serving it again.

Parameter	Type	Description
$job	ReservedJob

release()

abstract public function release(ReservedJob $job, int $delaySeconds): void

Return a reserved job to the backlog, available again after $delaySeconds.

Parameter	Type	Description
$job	ReservedJob
$delaySeconds	int

reserve()

abstract public function reserve(): ?ReservedJob

Claim and return the next due job, or null if the queue is empty.

Returns ?ReservedJob

Inherited methods

These come from an ancestor and are documented where they are declared.

Method	Declared in	Description
push()	QueueDriverInterface	Hands a job off to the driver’s backend.