ClearableQueuePoolProxy
class ClearableQueuePoolProxy extends QueuePoolProxy implements ClearableQueue
Properties
| protected string | $connectionName | The logical connection name applied to each borrowed queue. |
from QueuePoolProxy |
| protected Queue): mixed): mixed | $afterCommitDispatcher | from QueuePoolProxy |
Methods
Create a pooled queue proxy.
Invoke a synchronous method on a borrowed object.
Apply the proxy's logical connection name to a borrowed queue.
Get the number of pending jobs.
Get the number of delayed jobs.
Get the number of reserved jobs.
Get the pending jobs for the given queue.
Get the delayed jobs for the given queue.
Get the reserved jobs for the given queue.
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
Push a new job onto the queue.
Push a new job onto the queue.
Push a raw payload onto the queue.
Push a new job onto the queue after (n) seconds.
Push a new job onto a specific queue after (n) seconds.
Push an array of jobs onto the queue.
Pop the next job off of the queue.
Delete all of the jobs from the queue.
Details
in
QueuePoolProxy at line 37
__construct(PoolDefinition $definition, Closure $createCallback, Factory $pools, Closure|null $releaseCallback = null)
Create a pooled queue proxy.
in
PoolProxy at line 29
protected ObjectPool
pool()
Resolve the current pool for this proxy's definition.
in
PoolProxy at line 55
protected mixed
invoke(string $method, array $arguments)
Invoke a synchronous method on a borrowed object.
in
QueuePoolProxy at line 323
protected void
configureBorrowed(object $object)
Apply the proxy's logical connection name to a borrowed queue.
in
PoolProxy at line 80
PoolDefinition
getDefinition()
Get this proxy's immutable pool definition.
in
PoolProxy at line 88
string
getPoolName()
Return the pool's fully qualified registry name.
in
PoolProxy at line 96
bool
invalidatePool()
Remove and close this proxy's current shared pool.
in
QueuePoolProxy at line 59
int
size(UnitEnum|string|null $queue = null)
Get the size of the queue.
in
QueuePoolProxy at line 67
int
pendingSize(UnitEnum|string|null $queue = null)
Get the number of pending jobs.
in
QueuePoolProxy at line 75
int
delayedSize(UnitEnum|string|null $queue = null)
Get the number of delayed jobs.
in
QueuePoolProxy at line 83
int
reservedSize(UnitEnum|string|null $queue = null)
Get the number of reserved jobs.
in
QueuePoolProxy at line 91
int
totalSize()
Get the number of jobs across every queue.
in
QueuePoolProxy at line 99
int
totalPendingSize()
Get the number of pending jobs across every queue.
in
QueuePoolProxy at line 107
int
totalDelayedSize()
Get the number of delayed jobs across every queue.
in
QueuePoolProxy at line 115
int
totalReservedSize()
Get the number of reserved jobs across every queue.
in
QueuePoolProxy at line 123
Collection
pendingJobs(UnitEnum|string|null $queue = null)
Get the pending jobs for the given queue.
in
QueuePoolProxy at line 131
Collection
delayedJobs(UnitEnum|string|null $queue = null)
Get the delayed jobs for the given queue.
in
QueuePoolProxy at line 139
Collection
reservedJobs(UnitEnum|string|null $queue = null)
Get the reserved jobs for the given queue.
in
QueuePoolProxy at line 147
Collection
allPendingJobs()
Get all pending jobs across every queue.
in
QueuePoolProxy at line 155
Collection
allDelayedJobs()
Get all delayed jobs across every queue.
in
QueuePoolProxy at line 163
Collection
allReservedJobs()
Get all reserved jobs across every queue.
in
QueuePoolProxy at line 171
int|null
creationTimeOfOldestPendingJob(UnitEnum|string|null $queue = null)
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
in
QueuePoolProxy at line 179
mixed
push(object|string $job, mixed $data = '', UnitEnum|string|null $queue = null)
Push a new job onto the queue.
in
QueuePoolProxy at line 187
mixed
pushOn(UnitEnum|string|null $queue, object|string $job, mixed $data = '')
Push a new job onto the queue.
in
QueuePoolProxy at line 195
mixed
pushRaw(string $payload, UnitEnum|string|null $queue = null, array $options = [])
Push a raw payload onto the queue.
in
QueuePoolProxy at line 203
mixed
later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', UnitEnum|string|null $queue = null)
Push a new job onto the queue after (n) seconds.
in
QueuePoolProxy at line 211
mixed
laterOn(UnitEnum|string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
in
QueuePoolProxy at line 219
mixed
bulk(array $jobs, mixed $data = '', UnitEnum|string|null $queue = null)
Push an array of jobs onto the queue.
in
QueuePoolProxy at line 229
mixed
withConnection(Closure $callback)
Run a callback with the underlying SQS queue.
in
QueuePoolProxy at line 244
Job|null
pop(UnitEnum|string|null $queue = null, int $index = 0)
Pop the next job off of the queue.
in
QueuePoolProxy at line 305
string
getConnectionName()
Get the connection name for the queue.
in
QueuePoolProxy at line 313
Queue
setConnectionName(string $name)
Set the connection name for the queue.
in
QueuePoolProxy at line 335
protected mixed
usingConnection(Closure $callback)
Run a callback with a borrowed queue.
at line 15
int
clear(UnitEnum|string|null $queue = null)
Delete all of the jobs from the queue.