module Sidekiq::Job

Include this module in your job class and you can easily create asynchronous jobs:

class HardJob
  include Sidekiq::Job
  sidekiq_options queue: 'critical', retry: 5

  def perform(*args)
    # do some work
  end
end

Then in your Rails app, you can do this:

HardJob.perform_async(1, 2, 3)

Note that perform_async is a class method, perform is an instance method.

Sidekiq::Job also includes several APIs to provide compatibility with ActiveJob.

class SomeJob
  include Sidekiq::Job
  queue_as :critical

  def perform(...)
  end
end

SomeJob.set(wait_until: 1.hour).perform_async(123)

Note that arguments passed to the job must still obey Sidekiq’s best practice for simple, JSON-native data types. Sidekiq will not implement ActiveJob’s more complex argument serialization. For this reason, we don’t implement ‘perform_later` as our call semantics are very different.

Attributes

_context[RW]

This attribute is implementation-specific and not a public API

jid[RW]

Public Class Methods

clear_all() click to toggle source

Clear all queued jobs

# File lib/sidekiq/testing.rb, line 305
def clear_all
  Queues.clear_all
end
drain_all() click to toggle source

Drain (execute) all queued jobs

# File lib/sidekiq/testing.rb, line 310
def drain_all
  while jobs.any?
    job_classes = jobs.map { |job| job["class"] }.uniq

    job_classes.each do |job_class|
      Object.const_get(job_class).drain
    end
  end
end
included(base) click to toggle source
# File lib/sidekiq/job.rb, line 165
def self.included(base)
  raise ArgumentError, "Sidekiq::Job cannot be included in an ActiveJob: #{base.name}" if base.ancestors.any? { |c| c.name == "ActiveJob::Base" }

  base.include(Options)
  base.extend(ClassMethods)
end

Public Instance Methods

interrupted?() click to toggle source
# File lib/sidekiq/job.rb, line 176
def interrupted?
  @_context&.stopping?
end
logger() click to toggle source
# File lib/sidekiq/job.rb, line 172
def logger
  Sidekiq.logger
end