AbstractAdapter
in package
implements
AdapterInterface
AbstractYes
Adapter abstract class
Tags
Table of Contents
Interfaces
- AdapterInterface
- Adapter interface
Properties
- $priority : string
- Queue priority
Methods
- __construct() : mixed
- Constructor
- bury() : AdapterInterface
- Move a job to the dead-letter store (terminal)
- clear() : AdapterInterface
- Clear pending and reserved jobs (not dead-letter jobs)
- clearDead() : AdapterInterface
- count() : int
- Count of pending + reserved jobs
- countDead() : int
- delete() : AdapterInterface
- Permanently remove a job (success/ack)
- deleteDeadJob() : AdapterInterface
- getDeadJob() : mixed
- getDeadJobs() : array<string|int, mixed>
- getPriority() : string
- hasDeadJobs() : bool
- hasJobs() : bool
- Whether there are pending or reserved jobs
- isFifo() : bool
- isFilo() : bool
- isLifo() : bool
- isLilo() : bool
- push() : AdapterInterface
- Push a job onto the queue
- release() : AdapterInterface
- Put a reserved job back to pending. $delay overrides the job's own backoff schedule when given; otherwise release() computes the delay from $job->getBackoffDelay().
- reserve() : AbstractJob|null
- Atomically claim the next eligible job and lease it. Returns null if nothing is eligible (no pending jobs due, or all reserved jobs have a live lease).
- retryDeadJob() : AdapterInterface
- Move a dead-letter job back to pending
- setPriority() : AbstractAdapter
Properties
$priority
Queue priority
protected
string
$priority
= 'FIFO'
Methods
__construct()
Constructor
public
__construct([string|null $priority = null ]) : mixed
Parameters
- $priority : string|null = null
bury()
Move a job to the dead-letter store (terminal)
public
abstract bury(AbstractJob $job[, string|null $reason = null ]) : AdapterInterface
Parameters
- $job : AbstractJob
- $reason : string|null = null
Return values
AdapterInterfaceclear()
Clear pending and reserved jobs (not dead-letter jobs)
public
abstract clear() : AdapterInterface
Return values
AdapterInterfaceclearDead()
public
abstract clearDead() : AdapterInterface
Return values
AdapterInterfacecount()
Count of pending + reserved jobs
public
abstract count() : int
Return values
intcountDead()
public
abstract countDead() : int
Return values
intdelete()
Permanently remove a job (success/ack)
public
abstract delete(AbstractJob $job) : AdapterInterface
Parameters
- $job : AbstractJob
Return values
AdapterInterfacedeleteDeadJob()
public
abstract deleteDeadJob(string $jobId) : AdapterInterface
Parameters
- $jobId : string
Return values
AdapterInterfacegetDeadJob()
public
abstract getDeadJob(string $jobId[, bool $unserialize = true ]) : mixed
Parameters
- $jobId : string
- $unserialize : bool = true
getDeadJobs()
public
abstract getDeadJobs([bool $unserialize = true ]) : array<string|int, mixed>
Parameters
- $unserialize : bool = true
Return values
array<string|int, mixed>getPriority()
public
getPriority() : string
Return values
stringhasDeadJobs()
public
abstract hasDeadJobs() : bool
Return values
boolhasJobs()
Whether there are pending or reserved jobs
public
abstract hasJobs() : bool
Return values
boolisFifo()
public
isFifo() : bool
Return values
boolisFilo()
public
isFilo() : bool
Return values
boolisLifo()
public
isLifo() : bool
Return values
boolisLilo()
public
isLilo() : bool
Return values
boolpush()
Push a job onto the queue
public
abstract push(AbstractJob $job) : AdapterInterface
Parameters
- $job : AbstractJob
Return values
AdapterInterfacerelease()
Put a reserved job back to pending. $delay overrides the job's own backoff schedule when given; otherwise release() computes the delay from $job->getBackoffDelay().
public
abstract release(AbstractJob $job[, int|null $delay = null ]) : AdapterInterface
Parameters
- $job : AbstractJob
- $delay : int|null = null
Return values
AdapterInterfacereserve()
Atomically claim the next eligible job and lease it. Returns null if nothing is eligible (no pending jobs due, or all reserved jobs have a live lease).
public
abstract reserve() : AbstractJob|null
Return values
AbstractJob|nullretryDeadJob()
Move a dead-letter job back to pending
public
abstract retryDeadJob(string $jobId) : AdapterInterface
Parameters
- $jobId : string
Return values
AdapterInterfacesetPriority()
public
setPriority([string $priority = 'FIFO' ]) : AbstractAdapter
Parameters
- $priority : string = 'FIFO'