Exq.Enqueuer.enqueue
You're seeing just the function
enqueue
, go back to Exq.Enqueuer module for more information.
Enqueue a job immediately.
Expected args:
pid
- PID for Exq Manager or Enqueuer to handle thisqueue
- Name of queue to useworker
- Worker module to targetargs
- Array of args to send to workeroptions
: Following job options are supportedmax_retries
(integer) - max retry countjid
(string) - user supplied jid valueunique_for
(integer) - lock expiration duration in secondsunique_token
(string) - unique lock token. By default the token is computed based on the queue, class and args.unique_until
(atom) - defaults to:success
. Supported values are:success
- unlock on job success:start
- unlock on job first execution:expiry
- unlock when the lock is expired. Depends onunique_for
value.
Returns:
{:ok, jid}
if the job was enqueued successfully, withjid
= Job ID.{:error, reason}
if there was an error enqueueing job