Exq.Enqueuer.enqueue

You're seeing just the function enqueue, go back to Exq.Enqueuer module for more information.
Link to this function

enqueue(pid, queue, worker, args)

View Source

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: Following job options are supported
    • max_retries (integer) - max retry count
    • jid (string) - user supplied jid value
    • unique_for (integer) - lock expiration duration in seconds
    • unique_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 on unique_for value.

Returns:

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

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

View Source