Module: ActiveJob::Core
Overview
Provides general behavior that will be included into every Active Job object that inherits from ActiveJob::Base.
Defined Under Namespace
Modules: ClassMethods
Instance Method Summary collapse
-
#deserialize(job_data) ⇒ Object
Attaches the stored job data to the current instance.
-
#initialize(*arguments) ⇒ Object
Creates a new job instance.
-
#serialize ⇒ Object
Returns a hash with the job data that can safely be passed to the queueing adapter.
Instance Method Details
#deserialize(job_data) ⇒ Object
Attaches the stored job data to the current instance. Receives a hash returned from serialize
Examples
class DeliverWebhookJob < ActiveJob::Base
attr_writer :attempt_number
def attempt_number
@attempt_number ||= 0
end
def serialize
super.merge('attempt_number' => attempt_number + 1)
end
def deserialize(job_data)
super
self.attempt_number = job_data['attempt_number']
end
rescue_from(Timeout::Error) do |exception|
raise exception if attempt_number > 5
retry_job(wait: 10)
end
end
120 121 122 123 124 125 126 127 128 |
# File 'lib/active_job/core.rb', line 120 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 |
#initialize(*arguments) ⇒ Object
Creates a new job instance. Takes the arguments that will be passed to the perform method.
71 72 73 74 75 76 77 |
# File 'lib/active_job/core.rb', line 71 def initialize(*arguments) @arguments = arguments @job_id = SecureRandom.uuid @queue_name = self.class.queue_name @priority = self.class.priority @executions = 0 end |
#serialize ⇒ Object
Returns a hash with the job data that can safely be passed to the queueing adapter.
81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/active_job/core.rb', line 81 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_if_needed(arguments), "executions" => executions, "locale" => I18n.locale.to_s } end |