W3cubDocs

/Laravel 5.3

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

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

__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 = 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.

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.

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

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 = 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

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

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