BeanstalkdQueue

class BeanstalkdQueue extends Queue implements Queue (View source)

Properties

protected Container	$container	The IoC container instance.	from Queue
protected Encrypter	$encrypter	The encrypter implementation.	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

mixed

pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

from Queue

mixed

laterOn(string $queue, DateTime|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 = '', string $queue = null)

Create a payload string from the given job and data.

from Queue

array

createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

from Queue

string

setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

from Queue

int

getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

from Queue

int

getTime()

Get the current UNIX timestamp.

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 $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(DateTime|int $delay, string $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.

Details

mixed pushOn(string $queue, string $job, mixed $data = '')

Push a new job onto the queue.

Parameters

string	$queue
string	$job
mixed	$data

Return Value

mixed

mixed laterOn(string $queue, DateTime|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string	$queue
DateTime\|int	$delay
string	$job
mixed	$data

Return Value

mixed

mixed bulk(array $jobs, mixed $data = '', string $queue = null)

Push an array of jobs onto the queue.

Parameters

array	$jobs
mixed	$data
string	$queue

Return Value

mixed

protected string createPayload(string $job, mixed $data = '', string $queue = null)

Create a payload string from the given job and data.

Parameters

string	$job
mixed	$data
string	$queue

Return Value

string

Exceptions

InvalidArgumentException

protected array createPlainPayload(string $job, mixed $data)

Create a typical, "plain" queue payload array.

Parameters

string	$job
mixed	$data

Return Value

array

protected string setMeta(string $payload, string $key, string $value)

Set additional meta on a payload string.

Parameters

string	$payload
string	$key
string	$value

Return Value

string

Exceptions

InvalidArgumentException

protected int getSeconds(DateTime|int $delay)

Calculate the number of seconds with the given delay.

Parameters

DateTime|int

$delay

Return Value

int

protected int getTime()

Get the current UNIX timestamp.

Return Value

int

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container

$container

Return Value

void

void __construct(Pheanstalk $pheanstalk, string $default, int $timeToRun)

Create a new Beanstalkd queue instance.

Parameters

Pheanstalk	$pheanstalk
string	$default
int	$timeToRun

Return Value

void

int size(string $queue = null)

Get the size of the queue.

Parameters

string

$queue

Return Value

int

mixed push(string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue.

Parameters

string	$job
mixed	$data
string	$queue

Return Value

mixed

mixed pushRaw(string $payload, string $queue = null, array $options = [])

Push a raw payload onto the queue.

Parameters

string	$payload
string	$queue
array	$options

Return Value

mixed

mixed later(DateTime|int $delay, string $job, mixed $data = '', string $queue = null)

Push a new job onto the queue after a delay.

Parameters

DateTime\|int	$delay
string	$job
mixed	$data
string	$queue

Return Value

mixed

Job|null pop(string $queue = null)

Pop the next job off of the queue.

Parameters

string

$queue

Return Value

Job|null

void deleteMessage(string $queue, string $id)

Delete a message from the Beanstalk queue.

Parameters

string	$queue
string	$id

Return Value

void

string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null

$queue

Return Value

string

Pheanstalk getPheanstalk()

Get the underlying Pheanstalk instance.

Return Value

Pheanstalk

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Queue/BeanstalkdQueue.html