Exq (exq v0.16.0) View Source

Link to this section Summary

Functions

child_spec(exq_options \\ [])

enqueue(pid, queue, worker, args)

Enqueue a job immediately.

enqueue(pid, queue, worker, args, options)

enqueue_at(pid, queue, time, worker, args)

Schedule a job to be enqueued at a specific time in the future.

enqueue_at(pid, queue, time, worker, args, options)

enqueue_in(pid, queue, offset, worker, args)

Schedule a job to be enqueued at in the future given by offset in seconds.

enqueue_in(pid, queue, offset, worker, args, options)

start(type, args)

Callback implementation for Application.start/2.

start_link(opts \\ [])

subscribe(pid, queue)

Subscribe to a queue - ie. listen to queue for jobs

subscribe(pid, queue, concurrency)

subscriptions(pid)

List all subscriptions(active queues)

unsubscribe(pid, queue)

Unsubscribe from a queue - ie. stop listening to queue for jobs

unsubscribe_all(pid)

Unsubscribe from all queues - ie. stop listening for jobs

whereis(name)

worker_job(name \\ nil, pid \\ self())

Get the job metadata

Link to this section Functions

child_spec(exq_options \\ [])

enqueue(pid, queue, worker, args)

Enqueue a job immediately.

Expected args:

pid - PID for Exq Manager or Enqueuer to handle this
queue - Name of queue to use
worker - Worker module to target
args - Array of args to send to worker
options - job options, for example [max_retries: Integer, jid: String]

Returns:

{:ok, jid} if the job was enqueued successfully, with jid = Job ID.
{:error, reason} if there was an error enqueueing job

enqueue(pid, queue, worker, args, options)

enqueue_at(pid, queue, time, worker, args)

Schedule a job to be enqueued at a specific time in the future.

Expected args:

pid - PID for Exq Manager or Enqueuer to handle this
queue - name of queue to use
time - Time to enqueue
worker - Worker module to target
args - Array of args to send to worker
options - job options, for example [max_retries: Integer, jid: String]

If Exq is running in mode: [:enqueuer], then you will need to use the Enqueuer to schedule jobs, for example:

time = Timex.now() |> Timex.shift(days: 8)
Exq.Enqueuer.enqueue_at(Exq.Enqueuer, "default", time, MyWorker, ["foo"])

enqueue_at(pid, queue, time, worker, args, options)

enqueue_in(pid, queue, offset, worker, args)

Schedule a job to be enqueued at in the future given by offset in seconds.

Expected args:

pid - PID for Exq Manager or Enqueuer to handle this
queue - Name of queue to use
offset - Offset in seconds in the future to enqueue
worker - Worker module to target
args - Array of args to send to worker
options - job options, for example [max_retries: Integer]

If Exq is running in mode: [:enqueuer], then you will need to use the Enqueuer to schedule jobs, for example:

Exq.Enqueuer.enqueue_in(Exq.Enqueuer, "default", 5000, MyWorker, ["foo"])

enqueue_in(pid, queue, offset, worker, args, options)

start(type, args)

Callback implementation for Application.start/2.

start_link(opts \\ [])

subscriptions(pid)

List all subscriptions(active queues)

pid - PID for Exq Manager or Enqueuer to handle this

unsubscribe(pid, queue)

Unsubscribe from a queue - ie. stop listening to queue for jobs

pid - PID for Exq Manager or Enqueuer to handle this
queue - Name of queue

unsubscribe_all(pid)

Unsubscribe from all queues - ie. stop listening for jobs

pid - PID for Exq Manager or Enqueuer to handle this

whereis(name)

worker_job(name \\ nil, pid \\ self())

Get the job metadata

name - registered name of Exq. Only necessary if the custom name option is used when starting Exq. Defaults to Exq
pid - pid of the worker. Defaults to self().