RedisAdapter
class RedisAdapter extends QueueAdapter (View source)
Constants
| EXIT_SUCCESS |
|
| EXIT_ERROR |
|
| EXIT_MEMORY_LIMIT |
|
| private QUEUE_PREFIX |
Redis key prefix for queues |
| private PROCESSING_SUFFIX |
Redis key for processing tasks |
| private FAILED_SUFFIX |
Redis key for failed tasks |
Properties
| protected float | $start_time | Define the start time |
from QueueAdapter |
| protected float | $processing_timeout | Define the processing timeout |
from QueueAdapter |
| protected int | $timeout | Define the work time out |
from QueueAdapter |
| protected string | $queue | Determine the default watch name |
from QueueAdapter |
| protected int | $tries | The number of working attempts |
from QueueAdapter |
| protected int | $sleep | Define the sleep time |
from QueueAdapter |
| static protected bool | $suppressLogging | Whether to suppress logging (useful for testing) |
from QueueAdapter |
Methods
Enable or disable logging suppression
Configure the Redis queue adapter
Update the processing timeout
Run the queue worker
Get the size of the queue
Flush all tasks from the queue
Get failed tasks for a queue
Retry a failed task
Clear all failed tasks for a queue
Details
static void
suppressLogging(bool $suppress = true)
Enable or disable logging suppression
QueueAdapter
configure(array $config)
Configure the Redis queue adapter
bool
push(QueueTask $task)
Push a task onto the queue
string
serializeProducer(QueueTask $task)
Create task serialization
QueueTask
unserializeProducer(string $task)
Create task unserialize
void
sleep(int $seconds)
Sleep the process
void
setTimeout(int $timeout)
Set worker timeout
void
updateProcessingTimeout(int|null $timeout = null)
Update the processing timeout
final void
work(int $timeout, int $memory)
Launch the worker
protected bool
supportsAsyncSignals()
Determine if "async" signals are supported.
protected void
listenForSignals()
Enable async signals for the process.
void
run(string|null $queue = null)
Run the queue worker
protected bool
timeoutReached(int $timeout)
Determine if the timeout is reached
void
kill(int $status = 0)
Kill the process.
void
setTries(int $tries)
Set task tries
int
getTries()
Get task tries
void
setSleep(int $sleep)
Set sleep time
string
getQueue(string|null $queue = null)
Get the queue or return the default.
void
setQueue(string $queue)
Watch the queue name
int
size(string|null $queue = null)
Get the size of the queue
void
flush(string|null $queue = null)
Flush all tasks from the queue
protected void
logError(Throwable $exception)
Log an error
final protected string
generateId()
Generate the task id
protected void
logProcessingTask(QueueTask $task)
Log processing task
protected void
logProcessedTask(QueueTask $task)
Log processed task
array
getFailedTasks(string|null $queue = null)
Get failed tasks for a queue
bool
retryFailedTask(string $taskId, string|null $queue = null)
Retry a failed task
void
clearFailedTasks(string|null $queue = null)
Clear all failed tasks for a queue