Module: ActiveJob::Enqueuing

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
lib/active_job/enqueuing.rb

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#enqueue(options = {}) ⇒ Object

Enqueues the job to be performed by the queue adapter.

Options

  • :wait - Enqueues the job with the specified delay

  • :wait_until - Enqueues the job at the time specified

  • :queue - Enqueues the job on the specified queue

  • :priority - Enqueues the job with the specified priority

Examples

my_job_instance.enqueue
my_job_instance.enqueue wait: 5.minutes
my_job_instance.enqueue queue: :important
my_job_instance.enqueue wait_until: Date.tomorrow.midnight
my_job_instance.enqueue priority: 10



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/active_job/enqueuing.rb', line 112

def enqueue(options = {})
  set(options)
  self.successfully_enqueued = false

  run_callbacks :enqueue do
    raw_enqueue
  end

  if successfully_enqueued?
    self
  else
    false
  end
end