BeanstalkdQueue
class BeanstalkdQueue extends Queue implements Queue
Traits
Properties
| protected Container | $container | The IoC container instance. |
from Queue |
| protected Encrypter | $encrypter | The encrypter implementation. |
from Queue |
| protected string | $connectionName | The connection name for the queue. |
from Queue |
| protected Pheanstalk | $pheanstalk | The Pheanstalk instance. |
|
| protected string | $default | The name of the default tube. |
|
| protected int | $timeToRun | The "time to run" for all pushed jobs. |
Methods
Push a new job onto the queue.
Push a new job onto the queue after a delay.
Push an array of jobs onto the queue.
Create a payload string from the given job and data.
Create a payload array from the given job and data.
Create a payload for an object-based queue handler.
Create a typical, string based queue payload array.
Create a new Beanstalkd queue instance.
Get the size of the queue.
Push a new job onto the queue.
Push a raw payload onto the queue.
Delete a message from the Beanstalk queue.
Get the queue or return the default.
Get the underlying Pheanstalk instance.
Details
in
InteractsWithTime at line 16
protected int
secondsUntil(DateTimeInterface $delay)
Get the number of seconds until the given DateTime.
in
InteractsWithTime at line 29
protected int
availableAt(DateTimeInterface|int $delay = 0)
Get the "available at" UNIX timestamp.
in
InteractsWithTime at line 41
protected int
currentTime()
Get the current system time as a UNIX timestamp.
in
Queue at line 40
mixed
pushOn(string $queue, string $job, mixed $data = '')
Push a new job onto the queue.
in
Queue at line 54
mixed
laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')
Push a new job onto the queue after a delay.
in
Queue at line 67
mixed
bulk(array $jobs, mixed $data = '', string $queue = null)
Push an array of jobs onto the queue.
in
Queue at line 84
protected string
createPayload(string $job, mixed $data = '', string $queue = null)
Create a payload string from the given job and data.
in
Queue at line 105
protected array
createPayloadArray(string $job, mixed $data = '', string $queue = null)
Create a payload array from the given job and data.
in
Queue at line 118
protected array
createObjectPayload(mixed $job)
Create a payload for an object-based queue handler.
in
Queue at line 138
protected string
getDisplayName(mixed $job)
Get the display name for the given job.
in
Queue at line 151
protected array
createStringPayload(string $job, mixed $data)
Create a typical, string based queue payload array.
in
Queue at line 165
string
getConnectionName()
Get the connection name for the queue.
in
Queue at line 176
$this
setConnectionName(string $name)
Set the connection name for the queue.
at line 41
void
__construct(Pheanstalk $pheanstalk, string $default, int $timeToRun)
Create a new Beanstalkd queue instance.
at line 54
int
size(string $queue = null)
Get the size of the queue.
at line 69
mixed
push(string $job, mixed $data = '', string $queue = null)
Push a new job onto the queue.
at line 82
mixed
pushRaw(string $payload, string $queue = null, array $options = [])
Push a raw payload onto the queue.
at line 98
mixed
later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)
Push a new job onto the queue after a delay.
at line 116
Job|null
pop(string $queue = null)
Pop the next job off of the queue.
at line 136
void
deleteMessage(string $queue, string $id)
Delete a message from the Beanstalk queue.
at line 149
string
getQueue(string|null $queue)
Get the queue or return the default.
at line 159
Pheanstalk
getPheanstalk()
Get the underlying Pheanstalk instance.