Module: ActiveJob::Enqueuing

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

Overview

Provides behavior for enqueuing jobs.

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'activejob/lib/active_job/enqueuing.rb', line 46

def enqueue(options = {})
  self.scheduled_at = options[:wait].seconds.from_now.to_f if options[:wait]
  self.scheduled_at = options[:wait_until].to_f if options[:wait_until]
  self.queue_name   = self.class.queue_name_from_part(options[:queue]) if options[:queue]
  self.priority     = options[:priority].to_i if options[:priority]
  successfully_enqueued = false

  run_callbacks :enqueue do
    if scheduled_at
      queue_adapter.enqueue_at self, scheduled_at
    else
      queue_adapter.enqueue self
    end

    successfully_enqueued = true
  end

  if successfully_enqueued
    self
  else
    warn_against_after_callbacks_execution_deprecation(_enqueue_callbacks)

    if self.class.return_false_on_aborted_enqueue
      false
    else
      ActiveSupport::Deprecation.warn(
        "Rails 6.1 will return false when the enqueuing is aborted. Make sure your code doesn't depend on it" \
        " returning the instance of the job and set `config.active_job.return_false_on_aborted_enqueue = true`" \
        " to remove the deprecations."
      )

      self
    end
  end
end