RedisQueue
class RedisQueue extends Queue implements QueueInterface (View source)
Properties
| protected Container | $container | The IoC container instance. |
from Queue |
| protected Database | $redis | The Redis database instance. |
|
| protected string | $connection | The connection name. |
|
| protected string | $default | The name of the default queue. |
|
| protected int|null | $expire | The expiration time of a job. |
Methods
Push an array of jobs onto the queue.
Create a payload string from the given job and data.
Set additional meta on a payload string.
Create a new Redis queue instance.
Push a new job onto the queue.
Push a raw payload onto the queue.
Release a reserved job back onto the queue.
Delete a reserved job from the queue.
Migrate all of the waiting jobs in the queue.
Migrate the delayed jobs that are ready to the regular queue.
Get the expired jobs from a given queue.
Remove the expired jobs from a given queue.
Push all of the given jobs onto another queue.
Get a random ID string.
Get the queue or return the default.
Get the connection for the queue.
Get the expiration time in seconds.
Set the expiration time in seconds.
Details
in
Queue at line 23
marshal()
Marshal a push queue request and fire the job.
in
Queue at line 36
mixed
bulk(array $jobs, mixed $data = '', string $queue = null)
Push an array of jobs onto the queue.
protected string
createPayload(string $job, mixed $data = '', string $queue = null)
Create a payload string from the given job and data.
in
Queue at line 69
protected string
createClosurePayload(Closure $job, mixed $data)
Create a payload string for the given Closure job.
in
Queue at line 84
protected string
setMeta(string $payload, string $key, string $value)
Set additional meta on a payload string.
in
Queue at line 97
protected int
getSeconds(DateTime|int $delay)
Calculate the number of seconds with the given delay.
in
Queue at line 112
int
getTime()
Get the current UNIX timestamp.
in
Queue at line 123
void
setContainer(Container $container)
Set the IoC container instance.
in
Queue at line 134
void
setEncrypter(Encrypter $crypt)
Set the encrypter instance.
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.
protected void
migrateAllExpiredJobs(string $queue)
Migrate all of the waiting jobs in the queue.
void
migrateExpiredJobs(string $from, string $to)
Migrate the delayed jobs that are ready to the regular queue.
protected array
getExpiredJobs(MultiExec $transaction, string $from, int $time)
Get the expired jobs from a given queue.
protected void
removeExpiredJobs(MultiExec $transaction, string $from, int $time)
Remove the expired jobs from a given queue.
protected void
pushExpiredJobsOntoNewQueue(MultiExec $transaction, string $to, array $jobs)
Push all of the given jobs onto another queue.
protected string
getRandomId()
Get a random ID string.
protected string
getQueue(string|null $queue)
Get the queue or return the default.
protected ClientInterface
getConnection()
Get the connection for the 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.