Docs4dev
Docs
rails / 5.1 / activejob / core.html

module ActiveJob::Core

Provides general behavior that will be included into every Active Job object that inherits from ActiveJob::Base.

Public Class Methods

new(*arguments) Show source 
# File activejob/lib/active_job/core.rb, line 69
def initialize(*arguments)
  @arguments  = arguments
  @job_id     = SecureRandom.uuid
  @queue_name = self.class.queue_name
  @priority   = self.class.priority
  @executions = 0
end

Creates a new job instance. Takes the arguments that will be passed to the perform method.

Public Instance Methods

deserialize(job_data) Show source 
# File activejob/lib/active_job/core.rb, line 112
def deserialize(job_data)
  self.job_id               = job_data["job_id"]
  self.provider_job_id      = job_data["provider_job_id"]
  self.queue_name           = job_data["queue_name"]
  self.priority             = job_data["priority"]
  self.serialized_arguments = job_data["arguments"]
  self.executions           = job_data["executions"]
  self.locale               = job_data["locale"] || I18n.locale.to_s
end

Attaches the stored job data to the current instance. Receives a hash returned from serialize

Examples

class DeliverWebhookJob < ActiveJob::Base
  def serialize
    super.merge('attempt_number' => (@attempt_number || 0) + 1)
  end

  def deserialize(job_data)
    super
    @attempt_number = job_data['attempt_number']
  end

  rescue_from(TimeoutError) do |exception|
    raise exception if @attempt_number > 5
    retry_job(wait: 10)
  end
end
serialize() Show source 
# File activejob/lib/active_job/core.rb, line 79
def serialize
  {
    "job_class"  => self.class.name,
    "job_id"     => job_id,
    "provider_job_id" => provider_job_id,
    "queue_name" => queue_name,
    "priority"   => priority,
    "arguments"  => serialize_arguments(arguments),
    "executions" => executions,
    "locale"     => I18n.locale.to_s
  }
end

Returns a hash with the job data that can safely be passed to the queueing adapter.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.