LuaScripts
in package
Table of Contents
- migrateExpiredJobs() : string
- Get the Lua script to migrate expired jobs back onto the queue.
- pop() : string
- Get the Lua script for popping the next job off of the queue.
- release() : string
- Get the Lua script for releasing reserved jobs.
- size() : string
- Get the Lua script for computing the size of queue.
Methods
migrateExpiredJobs()
Get the Lua script to migrate expired jobs back onto the queue.
public
static migrateExpiredJobs() : string
KEYS[1] - The queue we are removing jobs from, for example: queues:foo:reserved KEYS[2] - The queue we are moving jobs to, for example: queues:foo ARGV[1] - The current UNIX timestamp
Return values
string —pop()
Get the Lua script for popping the next job off of the queue.
public
static pop() : string
KEYS[1] - The queue to pop jobs from, for example: queues:foo KEYS[2] - The queue to place reserved jobs on, for example: queues:foo:reserved ARGV[1] - The time at which the reserved job will expire
Return values
string —release()
Get the Lua script for releasing reserved jobs.
public
static release() : string
KEYS[1] - The "delayed" queue we release jobs onto, for example: queues:foo:delayed KEYS[2] - The queue the jobs are currently on, for example: queues:foo:reserved ARGV[1] - The raw payload of the job to add to the "delayed" queue ARGV[2] - The UNIX timestamp at which the job should become available
Return values
string —size()
Get the Lua script for computing the size of queue.
public
static size() : string
KEYS[1] - The name of the primary queue KEYS[2] - The name of the "delayed" queue KEYS[3] - The name of the "reserved" queue