RedisQueue

class RedisQueue extends Queue implements Queue (View source)

Traits

InteractsWithTime

Properties

protected Container $container The IoC container instance. from Queue
protected string $connectionName The connection name for the queue. from Queue
static protected callable[] $createPayloadCallbacks The create payload callbacks. from Queue
protected Factory $redis The Redis factory implementation.
protected string $connection The connection name.
protected string $default The name of the default queue.
protected int|null $retryAfter The expiration time of a job.
protected int|null $blockFor The maximum number of seconds to block for a job.

Methods

int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

 from InteractsWithTime
int currentTime()

Get the current system time as a UNIX timestamp.

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

Push a new job onto the queue.

 from Queue
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

 from Queue
void bulk(array $jobs, mixed $data = '', string|null $queue = null)

Push an array of jobs onto the queue.

 from Queue
string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

 from Queue
array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.
array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.

 from Queue
string getDisplayName(object $job)

Get the display name for the given job.

 from Queue
mixed getJobRetryDelay(mixed $job)

Get the retry delay for an object-based queue handler.

 from Queue
mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

 from Queue
array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

 from Queue
static void createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.

 from Queue
array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

 from Queue
string getConnectionName()

Get the connection name for the queue.

 from Queue
$this setConnectionName(string $name)

Set the connection name for the queue.

 from Queue
void setContainer(Container $container)

Set the IoC container instance.

 from Queue
void __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null)

Create a new Redis queue instance.
int size(string|null $queue = null)

Get the size of the queue.
mixed push(string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue.
mixed pushRaw(string $payload, string|null $queue = null, array $options = [])

Push a raw payload onto the queue.
mixed later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string|null $queue = null)

Push a new job onto the queue after a delay.
mixed laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string|null $queue = null)

Push a raw job onto the queue after a delay.
Job|null pop(string|null $queue = null)

Pop the next job off of the queue.
void migrate(string $queue)

Migrate any delayed or expired jobs onto the primary queue.
array migrateExpiredJobs(string $from, string $to)

Migrate the delayed jobs that are ready to the regular queue.
array retrieveNextJob(string $queue, bool $block = true)

Retrieve the next job from the queue.
void deleteReserved(string $queue, RedisJob $job)

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

Delete a reserved job from the reserved queue and release it.
string getRandomId()

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

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

Get the connection for the queue.
Factory getRedis()

Get the underlying Redis instance.

Details

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Get the number of seconds until the given DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Get the "available at" UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

If the given value is an interval, convert it to a DateTime instance.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Get the current system time as a UNIX timestamp.

Return Value

int

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, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')

Push a new job onto the queue after a delay.

Parameters

string $queue
DateTimeInterface|DateInterval|int $delay
string $job
mixed $data

Return Value

mixed

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

Push an array of jobs onto the queue.

Parameters

array $jobs
mixed $data
string|null $queue

Return Value

void

protected string createPayload(Closure|string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

Parameters

Closure|string|object $job
string $queue
mixed $data

Return Value

string

Exceptions

InvalidPayloadException

protected array createPayloadArray(string|object $job, string $queue, mixed $data = '')

Create a payload string from the given job and data.

Parameters

string|object $job
string $queue
mixed $data

Return Value

array

protected array createObjectPayload(object $job, string $queue)

Create a payload for an object-based queue handler.

Parameters

object $job
string $queue

Return Value

array

protected string getDisplayName(object $job)

Get the display name for the given job.

Parameters

object $job

Return Value

string

mixed getJobRetryDelay(mixed $job)

Get the retry delay for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

mixed getJobExpiration(mixed $job)

Get the expiration timestamp for an object-based queue handler.

Parameters

mixed $job

Return Value

mixed

protected array createStringPayload(string $job, string $queue, mixed $data)

Create a typical, string based queue payload array.

Parameters

string $job
string $queue
mixed $data

Return Value

array

static void createPayloadUsing(callable $callback)

Register a callback to be executed when creating job payloads.

Parameters

callable $callback

Return Value

void

protected array withCreatePayloadHooks(string $queue, array $payload)

Create the given payload using any registered payload hooks.

Parameters

string $queue
array $payload

Return Value

array

string getConnectionName()

Get the connection name for the queue.

Return Value

string

$this setConnectionName(string $name)

Set the connection name for the queue.

Parameters

string $name

Return Value

$this

void setContainer(Container $container)

Set the IoC container instance.

Parameters

Container $container

Return Value

void

void __construct(Factory $redis, string $default = 'default', string|null $connection = null, int $retryAfter = 60, int|null $blockFor = null)

Create a new Redis queue instance.

Parameters

Factory $redis
string $default
string|null $connection
int $retryAfter
int|null $blockFor

Return Value

void

int size(string|null $queue = null)

Get the size of the queue.

Parameters

string|null $queue

Return Value

int

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

Push a new job onto the queue.

Parameters

string|object $job
mixed $data
string|null $queue

Return Value

mixed

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

Push a raw payload onto the queue.

Parameters

string $payload
string|null $queue
array $options

Return Value

mixed

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

Push a new job onto the queue after a delay.

Parameters

DateTimeInterface|DateInterval|int $delay
string|object $job
mixed $data
string|null $queue

Return Value

mixed

protected mixed laterRaw(DateTimeInterface|DateInterval|int $delay, string $payload, string|null $queue = null)

Push a raw job onto the queue after a delay.

Parameters

DateTimeInterface|DateInterval|int $delay
string $payload
string|null $queue

Return Value

mixed

Job|null pop(string|null $queue = null)

Pop the next job off of the queue.

Parameters

string|null $queue

Return Value

Job|null

protected void migrate(string $queue)

Migrate any delayed or expired jobs onto the primary queue.

Parameters

string $queue

Return Value

void

array migrateExpiredJobs(string $from, string $to)

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

Parameters

string $from
string $to

Return Value

array

protected array retrieveNextJob(string $queue, bool $block = true)

Retrieve the next job from the queue.

Parameters

string $queue
bool $block

Return Value

array

void deleteReserved(string $queue, RedisJob $job)

Delete a reserved job from the queue.

Parameters

string $queue
RedisJob $job

Return Value

void

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

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

Parameters

string $queue
RedisJob $job
int $delay

Return Value

void

protected string getRandomId()

Get a random ID string.

Return Value

string

string getQueue(string|null $queue)

Get the queue or return the default.

Parameters

string|null $queue

Return Value

string

Connection getConnection()

Get the connection for the queue.

Return Value

Connection

Factory getRedis()

Get the underlying Redis instance.

Return Value

Factory

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