123456789_123456789_123456789_123456789_123456789_

Module: ActiveJob::QueueName

Relationships & Source Files
Namespace Children
Modules:
ClassMethods, FrozenQueueNameParts
Extension / Inclusion / Inheritance Descendants
Included In:
::ActionMailer::MailDeliveryJob, Base, ::ActiveRecord::DestroyAssociationAsyncJob
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveSupport::Concern
Defined in: activejob/lib/active_job/queue_name.rb

Class Attribute Summary

Class Method Summary

::ActiveSupport::Concern - Extended

class_methods

Define class methods from given block.
included

Evaluate given block in context of base class, so that you can write class macros here.
prepended

Evaluate given block in context of base class, so that you can write class macros here.
append_features, prepend_features

Instance Attribute Summary

Instance Method Summary

  • #queue_name

    Returns the name of the queue the job will be run on.

DSL Calls

included

[ GitHub ] 


76
77
78
79
80
81
82
# File 'activejob/lib/active_job/queue_name.rb', line 76

included do
  class_attribute :queue_name, instance_accessor: false, default: ActiveSupport::Ractors.shareable_proc { self.class.default_queue_name }
  class_attribute :queue_name_delimiter, instance_accessor: false, default: "_"
  class_attribute :queue_name_prefix

  singleton_class.prepend FrozenQueueNameParts
end

Class Attribute Details

.default_queue_name=(name) (writeonly)

This method is for internal use only.
[ GitHub ] 

  


# File 'activejob/lib/active_job/queue_name.rb', line 11



def self.default_queue_name=(name) # :nodoc:
  @default_queue_name = -name.to_s
end


  







Instance Attribute Details



  

    #default_queue_name   (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_name.rb', line 9



singleton_class.attr_reader :default_queue_name # :nodoc:


  







Instance Method Details



  

    #queue_name  
  



  

    
Returns the name of the queue the job will be run on.

  



  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_name.rb', line 85



def queue_name
  if @queue_name.is_a?(Proc)
    @queue_name = self.class.queue_name_from_part(instance_exec(&@queue_name))
  end
  @queue_name
end