1. class
  2. Hypervel
  3. \
  4. Queue
  5. \
  6. LuaScripts

LuaScripts

class LuaScripts

Methods

static string
size()

Get the Lua script for computing the size of queue.

static string
push()

Get the Lua script for pushing jobs onto the queue.

static string
later()

Get the Lua script for pushing delayed jobs onto the queue.

static string
bulk()

Get the Lua script for pushing a batch of immediate and delayed jobs.

static string
pop()

Get the Lua script for popping the next job off of the queue.

static string
release()

Get the Lua script for releasing reserved jobs.

static string
migrateExpiredJobs()

Get the Lua script to migrate expired jobs back onto the queue.

static string
clear()

Get the Lua script for removing all jobs from the queue.

Details

at line 16
static string size()

Get the Lua script for computing the size of queue.

KEYS[1] - The name of the primary queue KEYS[2] - The name of the "delayed" queue KEYS[3] - The name of the "reserved" queue

Return Value

string

at line 30
static string push()

Get the Lua script for pushing jobs onto the queue.

KEYS[1] - The queue to push the job onto, for example: queues:foo KEYS[2] - The notification list for the queue we are pushing jobs onto, for example: queues:foo:notify ARGV[1] - The job payload

Return Value

string

at line 50
static string later()

Get the Lua script for pushing delayed jobs onto the queue.

KEYS[1] - The delayed queue to push the job onto, for example: queues:foo:delayed ARGV[1] - The UNIX timestamp at which the job should become available ARGV[2] - The job payload

Return Value

string

at line 67
static string bulk()

Get the Lua script for pushing a batch of immediate and delayed jobs.

KEYS[1] - The queue to push immediate jobs onto KEYS[2] - The notification list for the queue KEYS[3] - The delayed queue to push delayed jobs onto ARGV[odd] - "i" for an immediate job, or its delayed availability timestamp ARGV[even] - The job payload paired with the preceding mode or timestamp

Return Value

string

at line 95
static string pop()

Get the Lua script for popping the next job off of the queue.

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 KEYS[3] - The notify queue ARGV[1] - The time at which the reserved job will expire

Return Value

string

at line 136
static string release()

Get the Lua script for releasing reserved jobs.

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 Value

string

at line 158
static string migrateExpiredJobs()

Get the Lua script to migrate expired jobs back onto the queue.

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 KEYS[3] - The notification list for the queue we are moving jobs to, for example queues:foo:notify ARGV[1] - The current UNIX timestamp ARGV[2] - The maximum number of jobs to migrate

Return Value

string

at line 191
static string clear()

Get the Lua script for removing all jobs from the queue.

KEYS[1] - The name of the primary queue KEYS[2] - The name of the "delayed" queue KEYS[3] - The name of the "reserved" queue KEYS[4] - The name of the "notify" queue

Return Value

string