RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Properties

protected Container $container The IoC container instance. 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
marshal() deprecated

Marshal a push queue request and fire the job.

 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
mixed prepareQueueableEntities(mixed $data)

Prepare any queueable entities for storage in the queue.

 from Queue
mixed prepareQueueableEntity(mixed $value)

Prepare a single queueable entity for storage on the queue.

 from Queue
string createClosurePayload(Closure $job, mixed $data)

Create a payload string for the given Closure job.

 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 setEncrypter(Encrypter $crypt)

Set the encrypter instance.

 from Queue
void __construct(Database $redis, string $default = 'default', string $connection = null)

Create a new Redis queue instance.
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.
void release(string $queue, string $payload, int $delay, int $attempts)

Release a reserved job back onto the queue.
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 migrateAllExpiredJobs(string $queue)

Migrate all of the waiting jobs in the queue.
void migrateExpiredJobs(string $from, string $to)

Migrate the delayed jobs that are ready to the regular queue.
array getExpiredJobs(MultiExec $transaction, string $from, int $time)

Get the expired jobs from a given queue.
void removeExpiredJobs(MultiExec $transaction, string $from, int $time)

Remove the expired jobs from a given queue.
void pushExpiredJobsOntoNewQueue(MultiExec $transaction, string $to, array $jobs)

Push all of the given jobs onto another 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.
int|null getExpire()

Get the expiration time in seconds.
void setExpire(int|null $seconds)

Set the expiration time in seconds.

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

marshal() deprecated

deprecated

since version 5.1.

Marshal a push queue request and fire the job.

Exceptions

RuntimeException

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 mixed prepareQueueableEntities(mixed $data)

Prepare any queueable entities for storage in the queue.

Parameters

mixed $data

Return Value

mixed

protected mixed prepareQueueableEntity(mixed $value)

Prepare a single queueable entity for storage on the queue.

Parameters

mixed $value

Return Value

mixed

protected string createClosurePayload(Closure $job, mixed $data)

Create a payload string for the given Closure job.

Parameters

Closure $job
mixed $data

Return Value

string

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

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 setEncrypter(Encrypter $crypt)

Set the encrypter instance.

Parameters

Encrypter $crypt

Return Value

void

void __construct(Database $redis, string $default = 'default', string $connection = null)

Create a new Redis queue instance.

Parameters

Database $redis
string $default
string $connection

Return Value

void

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

void release(string $queue, string $payload, int $delay, int $attempts)

Release a reserved job back onto the queue.

Parameters

string $queue
string $payload
int $delay
int $attempts

Return Value

void

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

protected void migrateAllExpiredJobs(string $queue)

Migrate all of the waiting jobs in the queue.

Parameters

string $queue

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 array getExpiredJobs(MultiExec $transaction, string $from, int $time)

Get the expired jobs from a given queue.

Parameters

MultiExec $transaction
string $from
int $time

Return Value

array

protected void removeExpiredJobs(MultiExec $transaction, string $from, int $time)

Remove the expired jobs from a given queue.

Parameters

MultiExec $transaction
string $from
int $time

Return Value

void

protected void pushExpiredJobsOntoNewQueue(MultiExec $transaction, string $to, array $jobs)

Push all of the given jobs onto another queue.

Parameters

MultiExec $transaction
string $to
array $jobs

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

int|null getExpire()

Get the expiration time in seconds.

Return Value

int|null

void setExpire(int|null $seconds)

Set the expiration time in seconds.

Parameters

int|null $seconds

Return Value

void

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