module ActiveJob::QueueAdapter::ClassMethods

Includes the setter method for changing the active queue adapter.

Constants

QUEUE_ADAPTER_METHODS

Public Instance Methods

queue_adapter() click to toggle source

Returns the backend queue provider. The default queue adapter is the :async queue. See QueueAdapters for more information.

# File lib/active_job/queue_adapter.rb, line 20
def queue_adapter
  _queue_adapter
end
queue_adapter=(name_or_adapter_or_class) click to toggle source

Specify the backend queue provider. The default queue adapter is the :async queue. See QueueAdapters for more information.

# File lib/active_job/queue_adapter.rb, line 27
def queue_adapter=(name_or_adapter_or_class)
  self._queue_adapter = interpret_adapter(name_or_adapter_or_class)
end

Private Instance Methods

interpret_adapter(name_or_adapter_or_class) click to toggle source
# File lib/active_job/queue_adapter.rb, line 33
def interpret_adapter(name_or_adapter_or_class)
  case name_or_adapter_or_class
  when Symbol, String
    ActiveJob::QueueAdapters.lookup(name_or_adapter_or_class).new
  else
    if queue_adapter?(name_or_adapter_or_class)
      name_or_adapter_or_class
    elsif queue_adapter_class?(name_or_adapter_or_class)
      ActiveSupport::Deprecation.warn "Passing an adapter class is deprecated "                "and will be removed in Rails 5.1. Please pass an adapter name "                "(.queue_adapter = :#{name_or_adapter_or_class.name.demodulize.remove('Adapter').underscore}) "                "or an instance (.queue_adapter = #{name_or_adapter_or_class.name}.new) instead."
        name_or_adapter_or_class.new
    else
      raise ArgumentError
    end
  end
end
queue_adapter?(object) click to toggle source
# File lib/active_job/queue_adapter.rb, line 54
def queue_adapter?(object)
  QUEUE_ADAPTER_METHODS.all? { |meth| object.respond_to?(meth) }
end
queue_adapter_class?(object) click to toggle source
# File lib/active_job/queue_adapter.rb, line 58
def queue_adapter_class?(object)
  object.is_a?(Class) && QUEUE_ADAPTER_METHODS.all? { |meth| object.public_method_defined?(meth) }
end