QueuePoolProxy
class QueuePoolProxy extends PoolProxy implements Queue
Properties
| protected string | $connectionName | The logical connection name applied to each borrowed queue. |
|
| protected Queue): mixed): mixed | $afterCommitDispatcher |
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 size of the 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 all pending jobs across every queue.
Get all delayed jobs across every queue.
Get all reserved jobs across every 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.
Get the connection name for the queue.
Set the connection name for the queue.
Details
at line 34
__construct(PoolDefinition $definition, Closure $resolver, Factory $pools, Closure|null $releaseCallback = null)
Create a pooled queue proxy.
in
PoolProxy at line 28
protected ObjectPool
pool()
Resolve the current pool for this proxy's definition.
in
PoolProxy at line 59
protected mixed
invoke(string $method, array $arguments)
Invoke a synchronous method on a borrowed object.
at line 297
protected void
configureBorrowed(object $object)
Apply the proxy's logical connection name to a borrowed queue.
in
PoolProxy at line 90
PoolDefinition
getDefinition()
Get this proxy's immutable pool definition.
in
PoolProxy at line 98
string
getPoolName()
Get this proxy's pool identity.
in
PoolProxy at line 106
bool
invalidatePool()
Remove and close this proxy's current shared pool.
at line 56
int
size(string|null $queue = null)
Get the size of the queue.
at line 64
int
pendingSize(string|null $queue = null)
Get the number of pending jobs.
at line 72
int
delayedSize(string|null $queue = null)
Get the number of delayed jobs.
at line 80
int
reservedSize(string|null $queue = null)
Get the number of reserved jobs.
at line 88
Collection
pendingJobs(string|null $queue = null)
Get the pending jobs for the given queue.
at line 96
Collection
delayedJobs(string|null $queue = null)
Get the delayed jobs for the given queue.
at line 104
Collection
reservedJobs(string|null $queue = null)
Get the reserved jobs for the given queue.
at line 112
Collection
allPendingJobs()
Get all pending jobs across every queue.
at line 120
Collection
allDelayedJobs()
Get all delayed jobs across every queue.
at line 128
Collection
allReservedJobs()
Get all reserved jobs across every queue.
at line 136
int|null
creationTimeOfOldestPendingJob(string|null $queue = null)
Get the creation timestamp of the oldest pending job, excluding delayed jobs.
at line 144
mixed
push(object|string $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue.
at line 152
mixed
pushOn(string|null $queue, object|string $job, mixed $data = '')
Push a new job onto the queue.
at line 160
mixed
pushRaw(string $payload, string|null $queue = null, array $options = [])
Push a raw payload onto the queue.
at line 168
mixed
later(DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '', string|null $queue = null)
Push a new job onto the queue after (n) seconds.
at line 176
mixed
laterOn(string|null $queue, DateInterval|DateTimeInterface|int $delay, object|string $job, mixed $data = '')
Push a new job onto a specific queue after (n) seconds.
at line 184
mixed
bulk(array $jobs, mixed $data = '', string|null $queue = null)
Push an array of jobs onto the queue.
at line 194
mixed
withConnection(Closure $callback)
Run a callback with the underlying SQS queue.
at line 209
Job|null
pop(string|null $queue = null)
Pop the next job off of the queue.
at line 279
string
getConnectionName()
Get the connection name for the queue.
at line 287
Queue
setConnectionName(string $name)
Set the connection name for the queue.
at line 309
protected mixed
usingConnection(Closure $callback)
Run a callback with a borrowed queue.