Class: Sidekiq::Client

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

Class Method Summary collapse

Class Method Details

.enqueue(klass, *args) ⇒ Object

Please use .push if possible instead.

Example usage:

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

Messages are enqueued to the ‘default’ queue. Optionally, MyWorker can define a queue class method:

def self.queue
  'my_queue'
end



43
44
45
46
 
# File 'lib/sidekiq/client.rb', line 43

def self.enqueue(klass, *args)
  queue = (klass.respond_to?(:queue) && klass.queue) || 'default'
  push(queue, { 'class' => klass.name, 'args' => args })
end

.push(queue = 'default', item) ⇒ Object

Example usage: Sidekiq::Client.push(‘my_queue’, ‘class’ => MyWorker, ‘args’ => [‘foo’, 1, :bat => ‘bar’])

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
 
# File 'lib/sidekiq/client.rb', line 22

def self.push(queue='default', item)
  raise(ArgumentError, "Message must be a Hash of the form: { 'class' => SomeClass, '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']

  item['class'] = item['class'].to_s if !item['class'].is_a?(String)
  redis.rpush("queue:#{queue}", MultiJson.encode(item))
end

.redis ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/sidekiq/client.rb', line 7

def self.redis
  @redis ||= begin
    # autoconfig for Heroku
    hash = {}
    hash[:url] = ENV['REDISTOGO_URL'] if ENV['REDISTOGO_URL']
    Redis.connect(hash)
  end
end

.redis=(redis) ⇒ Object 



16
17
18
 
# File 'lib/sidekiq/client.rb', line 16

def self.redis=(redis)
  @redis = redis
end