1. class
  2. Core
  3. \
  4. Lib
  5. \
  6. Queue
  7. \
  8. RedisQueueDriver

RedisQueueDriver

class RedisQueueDriver implements QueueDriverInterface

Implements the QueueDriverInterface. This driver implements functions that support Redis queue operations.

Properties

protected Client $redis

The redis client.

Methods

__construct(Client $redis)

The constructor for the RedisQueueDriver.

void
delete(mixed $jobId)

Deletes a job from the queue. Is a no-op with Redis.

array|null
pop(string $queue)

Retrieves and reserves the next available job from the specified queue.

void
push(string $queue, array $payload)

Pushes a new job onto the specified queue.

void
release(string $queue, array $payload, int $delay = 0)

Releases a job back onto the queue after a failure or delay.

Details

at line 25
__construct(Client $redis)

The constructor for the RedisQueueDriver.

Parameters

Client $redis

The redis client.

at line 35
void delete(mixed $jobId)

Deletes a job from the queue. Is a no-op with Redis.

Parameters

mixed $jobId

The unique identifier of the job to delete.

Return Value

void

at line 43
array|null pop(string $queue)

Retrieves and reserves the next available job from the specified queue.

Parameters

string $queue

The name of the queue to pop from.

Return Value

array|null

The job payload as an associative array, or null if no job is available.

at line 59
void push(string $queue, array $payload)

Pushes a new job onto the specified queue.

Parameters

string $queue

The name of the queue to push the job to.
array $payload

The job payload, typically containing the class name and data.

Return Value

void

at line 71
void release(string $queue, array $payload, int $delay = 0)

Releases a job back onto the queue after a failure or delay.

Parameters

string $queue

The name of the queue to release the job to.
array $payload

The job payload to requeue.
int $delay

Delay in seconds before the job becomes available again.

Return Value

void