class BeanstalkdQueue extends Queue implements Queue (View source)
InteractsWithTime |
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. |
int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Get the number of seconds until the given DateTime. | from InteractsWithTime |
int | availableAt(DateTimeInterface|DateInterval|int $delay) Get the "available at" UNIX timestamp. | from InteractsWithTime |
DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) If the given value is an interval, convert it to a DateTime instance. | from InteractsWithTime |
int | currentTime() Get the current system time as a UNIX timestamp. | from InteractsWithTime |
mixed | pushOn(string $queue, string $job, mixed $data = '') Push a new job onto the queue. | from Queue |
mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '') Push a new job onto the queue after a delay. | from Queue |
mixed | bulk(array $jobs, mixed $data = '', string $queue = null) Push an array of jobs onto the queue. | from Queue |
string | createPayload(string $job, mixed $data = '') Create a payload string from the given job and data. | from Queue |
array | createPayloadArray(string $job, mixed $data = '') Create a payload array from the given job and data. | from Queue |
array | createObjectPayload(mixed $job) Create a payload for an object-based queue handler. | from Queue |
string | getDisplayName(mixed $job) Get the display name for the given job. | from Queue |
mixed | getJobExpiration(mixed $job) Get the expiration timestamp for an object-based queue handler. | from Queue |
array | createStringPayload(string $job, mixed $data) Create a typical, string based queue payload array. | from Queue |
string | getConnectionName() Get the connection name for the queue. | from Queue |
$this | setConnectionName(string $name) Set the connection name for the queue. | from Queue |
void | setContainer(Container $container) Set the IoC container instance. | from Queue |
void | __construct(Pheanstalk $pheanstalk, string $default, int $timeToRun) Create a new Beanstalkd queue instance. | |
int | size(string $queue = null) Get the size of the queue. | |
mixed | push(string|object $job, mixed $data = '', string $queue = null) Push a new job onto the queue. | |
mixed | pushRaw(string $payload, string $queue = null, array $options = []) Push a raw payload onto the queue. | |
mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null) Push a new job onto the queue after a delay. | |
Job|null | pop(string $queue = null) Pop the next job off of the queue. | |
void | deleteMessage(string $queue, string $id) Delete a message from the Beanstalk queue. | |
string | getQueue(string|null $queue) Get the queue or return the default. | |
Pheanstalk | getPheanstalk() Get the underlying Pheanstalk instance. |
Get the number of seconds until the given DateTime.
Get the "available at" UNIX timestamp.
If the given value is an interval, convert it to a DateTime instance.
Get the current system time as a UNIX timestamp.
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.
Get the display name for the given job.
Get the expiration timestamp for an object-based queue handler.
Create a typical, string based queue payload array.
Get the connection name for the queue.
Set the connection name for the queue.
Set the IoC container instance.
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.
Push a new job onto the queue after a delay.
Pop the next job off of the queue.
Delete a message from the Beanstalk queue.
Get the queue or return the default.
Get the underlying Pheanstalk instance.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Queue/BeanstalkdQueue.html