Module: ActiveJob
Overview
:markup: markdown
Class Method Summary
-
.gem_version
Returns the currently loaded version of Active Job as a
Gem::Version
. -
.perform_all_later(*jobs)
Push many jobs onto the queue at once without running enqueue callbacks.
-
.verbose_enqueue_logs
Specifies if the methods calling background job enqueue should be logged below their relevant enqueue log lines.
-
.version
Returns the currently loaded version of Active Job as a
Gem::Version
. - .instrument_enqueue_all(queue_adapter, jobs) private
- .adapter_name(adapter) Internal use only
- .deprecator Internal use only
::ActiveSupport::Autoload
- Extended
Instance Attribute Summary
Class Method Details
.adapter_name(adapter)
# File 'activejob/lib/active_job/queue_adapter.rb', line 7
def adapter_name(adapter) # :nodoc: return adapter.queue_adapter_name if adapter.respond_to?(:queue_adapter_name) adapter_class = adapter.is_a?(Module) ? adapter : adapter.class "#{adapter_class.name.demodulize.delete_suffix('Adapter')}" end
.deprecator
# File 'activejob/lib/active_job/deprecator.rb', line 4
def self.deprecator # :nodoc: @deprecator ||= ActiveSupport::Deprecation.new end
.gem_version
Returns the currently loaded version of Active Job as a Gem::Version
.
.instrument_enqueue_all(queue_adapter, jobs) (private)
[ GitHub ]# File 'activejob/lib/active_job/instrumentation.rb', line 6
def instrument_enqueue_all(queue_adapter, jobs) payload = { adapter: queue_adapter, jobs: jobs } ActiveSupport::Notifications.instrument("enqueue_all.active_job", payload) do result = yield payload payload[:enqueued_count] = result result end end
.perform_all_later(*jobs)
Push many jobs onto the queue at once without running enqueue callbacks. Queue adapters may communicate the enqueue status of each job by setting successfully_enqueued and/or enqueue_error on the passed-in job instances.
# File 'activejob/lib/active_job/enqueuing.rb', line 14
def perform_all_later(*jobs) jobs.flatten! jobs.group_by(&:queue_adapter).each do |queue_adapter, adapter_jobs| instrument_enqueue_all(queue_adapter, adapter_jobs) do if queue_adapter.respond_to?(:enqueue_all) queue_adapter.enqueue_all(adapter_jobs) else adapter_jobs.each do |job| job.successfully_enqueued = false if job.scheduled_at queue_adapter.enqueue_at(job, job.scheduled_at.to_f) else queue_adapter.enqueue(job) end job.successfully_enqueued = true rescue EnqueueError => e job.enqueue_error = e end adapter_jobs.count(&:successfully_enqueued?) end end end nil end
.verbose_enqueue_logs
Specifies if the methods calling background job enqueue should be logged below their relevant enqueue log lines. Defaults to false.
# File 'activejob/lib/active_job.rb', line 57
RDoc directive :singleton-method: verbose_enqueue_logs
.version
Returns the currently loaded version of Active Job as a Gem::Version
.
# File 'activejob/lib/active_job/version.rb', line 7
def self.version gem_version end
Instance Attribute Details
#verbose_enqueue_logs (rw)
[ GitHub ]# File 'activejob/lib/active_job.rb', line 57
singleton_class.attr_accessor :verbose_enqueue_logs