W3cubDocs

/Laravel 5.1

RedisQueue

class RedisQueue extends Queue implements Queue (View source)

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()

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
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 = array())

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 migrateExpiredJobs( string $from, string $to)

Migrate the delayed jobs that are ready to the regular 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()

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

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 = array())

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

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

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