Class: Sidekiq::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/sidekiq/client.rb

Class Method Summary collapse

Class Method Details

.default_middleware ⇒ Object 



9
10
11
12
 
# File 'lib/sidekiq/client.rb', line 9

def self.default_middleware
  Middleware::Chain.new do |m|
  end
end

.enqueue(klass, *args) ⇒ Object

Redis compatibility helper. Example usage:

Sidekiq::Client.enqueue(MyWorker, 'foo', 1, :bat => 'bar')

Messages are enqueued to the ‘default’ queue.



68
69
70
 
# File 'lib/sidekiq/client.rb', line 68

def self.enqueue(klass, *args)
  klass.perform_async(*args)
end

.push(item) ⇒ Object

The main method used to push a job to Redis. Accepts a number of options:

queue - the named queue to use, default 'default'
class - the worker class to call, required
args - an array of simple arguments to the perform method, must be JSON-serializable
retry - whether to retry this job if it fails, true or false, default true
backtrace - whether to save any error backtrace, default false

All options must be strings, not symbols. NB: because we are serializing to JSON, all symbols in ‘args’ will be converted to strings.

Example:

Sidekiq::Client.push('queue' => 'my_queue', 'class' => MyWorker, 'args' => ['foo', 1, :bat => 'bar'])

Raises:

  • (ArgumentError) 


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/sidekiq/client.rb', line 37

def self.push(item)
  raise(ArgumentError, "Message must be a Hash of the form: { 'class' => SomeWorker, 'args' => ['bob', 1, :foo => 'bar'] }") unless item.is_a?(Hash)
  raise(ArgumentError, "Message must include a class and set of arguments: #{item.inspect}") if !item['class'] || !item['args']
  raise(ArgumentError, "Message must include a Sidekiq::Worker class, not class name: #{item['class'].ancestors.inspect}") if !item['class'].is_a?(Class) || !item['class'].respond_to?('get_sidekiq_options')

  worker_class = item['class']
  item['class'] = item['class'].to_s

  item = worker_class.get_sidekiq_options.merge(item)
  item['retry'] = !!item['retry']
  queue = item['queue']

  pushed = false
  Sidekiq.client_middleware.invoke(worker_class, item, queue) do
    payload = Sidekiq.dump_json(item)
    Sidekiq.redis do |conn|
      _, pushed = conn.multi do
        conn.sadd('queues', queue)
        conn.rpush("queue:#{queue}", payload)
      end
    end
  end
  !! pushed
end

.registered_queues ⇒ Object 



18
19
20
 
# File 'lib/sidekiq/client.rb', line 18

def self.registered_queues
  Sidekiq.redis { |x| x.smembers('queues') }
end

.registered_workers ⇒ Object 



14
15
16
 
# File 'lib/sidekiq/client.rb', line 14

def self.registered_workers
  Sidekiq.redis { |x| x.smembers('workers') }
end