RedisQueue

class RedisQueue 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 Database $redis The Redis database instance.
protected string $connection The connection name.
protected string $default The name of the default queue.
protected int|null $expire The expiration time of a job.

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.
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(Database $redis, string $default = 'default', string $connection = null, int $expire = 60)

Create a new Redis 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 deleteReserved(string $queue, string $job)

Delete a reserved job from the queue.
void deleteAndRelease(string $queue, string $job, int $delay)

Delete a reserved job from the reserved queue and release it.
void migrateExpiredJobs(string $from, string $to)

Migrate the delayed jobs that are ready to the regular queue.
string getRandomId()

Get a random ID string.
string getQueue(string|null $queue)

Get the queue or return the default.
ClientInterface getConnection()

Get the connection for the queue.
Database getRedis()

Get the underlying Redis 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

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(Database $redis, string $default = 'default', string $connection = null, int $expire = 60)

Create a new Redis queue instance.

Parameters

Database $redis
string $default
string $connection
int $expire

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 deleteReserved(string $queue, string $job)

Delete a reserved job from the queue.

Parameters

string $queue
string $job

Return Value

void

void deleteAndRelease(string $queue, string $job, int $delay)

Delete a reserved job from the reserved queue and release it.

Parameters

string $queue
string $job
int $delay

Return Value

void

void migrateExpiredJobs(string $from, string $to)

Migrate the delayed jobs that are ready to the regular queue.

Parameters

string $from
string $to

Return Value

void

protected string getRandomId()

Get a random ID string.

Return Value

string

protected string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

protected ClientInterface getConnection()

Get the connection for the queue.

Return Value

ClientInterface

Database getRedis()

Get the underlying Redis instance.

Return Value

Database

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