Class: Sidekiq::Client
- Inherits:
-
Object
- Object
- Sidekiq::Client
- Defined in:
- lib/sidekiq/client.rb
Class Method Summary collapse
- .default_middleware ⇒ Object
-
.enqueue(klass, *args) ⇒ Object
Redis compatibility helper.
-
.push(item) ⇒ Object
The main method used to push a job to Redis.
- .registered_queues ⇒ Object
- .registered_workers ⇒ Object
Class Method Details
.default_middleware ⇒ Object
7 8 9 10 |
# File 'lib/sidekiq/client.rb', line 7 def self.default_middleware Middleware::Chain.new do |m| end end |
.enqueue(klass, *args) ⇒ Object
70 71 72 |
# File 'lib/sidekiq/client.rb', line 70 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'])
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/sidekiq/client.rb', line 35 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..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| if item['at'] pushed = (conn.zadd('schedule', item['at'].to_s, payload) == 1) else _, pushed = conn.multi do conn.sadd('queues', queue) conn.rpush("queue:#{queue}", payload) end end end end !! pushed end |