Module: Sidekiq
- Defined in:
- lib/sidekiq.rb,
lib/sidekiq/api.rb,
lib/sidekiq/cli.rb,
lib/sidekiq/web.rb,
lib/sidekiq/util.rb,
lib/sidekiq/fetch.rb,
lib/sidekiq/rails.rb,
lib/sidekiq/client.rb,
lib/sidekiq/worker.rb,
lib/sidekiq/logging.rb,
lib/sidekiq/manager.rb,
lib/sidekiq/testing.rb,
lib/sidekiq/version.rb,
lib/sidekiq/launcher.rb,
lib/sidekiq/paginator.rb,
lib/sidekiq/processor.rb,
lib/sidekiq/scheduled.rb,
lib/sidekiq/testing/inline.rb,
lib/sidekiq/middleware/chain.rb,
lib/sidekiq/redis_connection.rb,
lib/sidekiq/exception_handler.rb,
lib/sidekiq/extensions/action_mailer.rb,
lib/sidekiq/extensions/active_record.rb,
lib/sidekiq/extensions/class_methods.rb,
lib/sidekiq/extensions/generic_proxy.rb,
lib/sidekiq/middleware/server/logging.rb,
lib/sidekiq/middleware/server/timeout.rb,
lib/sidekiq/middleware/server/retry_jobs.rb,
lib/sidekiq/middleware/server/active_record.rb
Defined Under Namespace
Modules: ExceptionHandler, Extensions, Logging, Middleware, Paginator, Scheduled, Util, Worker
Classes: BasicFetch, CLI, Client, Fetcher, Job, Launcher, Manager, Processor, Queue, Rails, RedisConnection, RetrySet, ScheduledSet, SortedEntry, SortedSet, Stats, Web, Workers
Constant Summary
collapse
- NAME =
"Sidekiq"
- LICENSE =
'See LICENSE and the LGPL-3.0 for licensing details.'
- DEFAULTS =
{
:queues => [],
:concurrency => 25,
:require => '.',
:environment => nil,
:timeout => 8,
:profile => false,
}
- VERSION =
"2.7.4"
Class Method Summary
collapse
Class Method Details
.client_middleware {|@client_chain| ... } ⇒ Object
86
87
88
89
90
|
# File 'lib/sidekiq.rb', line 86
def self.client_middleware
@client_chain ||= Client.default_middleware
yield @client_chain if block_given?
@client_chain
end
|
Configuration for Sidekiq client, use like:
Sidekiq.configure_client do |config|
config.redis = { :namespace => 'myapp', :size => 1, :url => 'redis://myhost:8877/mydb' }
end
61
62
63
|
# File 'lib/sidekiq.rb', line 61
def self.configure_client
yield self unless server?
end
|
Configuration for Sidekiq server, use like:
Sidekiq.configure_server do |config|
config.redis = { :namespace => 'myapp', :size => 25, :url => 'redis://myhost:8877/mydb' }
config.server_middleware do |chain|
chain.add MyServerHook
end
end
51
52
53
|
# File 'lib/sidekiq.rb', line 51
def self.configure_server
yield self if server?
end
|
.dump_json(object) ⇒ Object
102
103
104
|
# File 'lib/sidekiq.rb', line 102
def self.dump_json(object)
MultiJson.encode(object)
end
|
.load_json(string) ⇒ Object
98
99
100
|
# File 'lib/sidekiq.rb', line 98
def self.load_json(string)
MultiJson.decode(string, :symbolize_keys => false)
end
|
.logger=(log) ⇒ Object
110
111
112
|
# File 'lib/sidekiq.rb', line 110
def self.logger=(log)
Sidekiq::Logging.logger = log
end
|
.options ⇒ Object
34
35
36
|
# File 'lib/sidekiq.rb', line 34
def self.options
@options ||= DEFAULTS.dup
end
|
.options=(opts) ⇒ Object
38
39
40
|
# File 'lib/sidekiq.rb', line 38
def self.options=(opts)
@options = opts
end
|
.poll_interval=(interval) ⇒ Object
114
115
116
|
# File 'lib/sidekiq.rb', line 114
def self.poll_interval=(interval)
self.options[:poll_interval] = interval
end
|
.redis(&block) ⇒ Object
69
70
71
72
73
|
# File 'lib/sidekiq.rb', line 69
def self.redis(&block)
raise ArgumentError, "requires a block" if !block
@redis ||= Sidekiq::RedisConnection.create
@redis.with(&block)
end
|
.redis=(hash) ⇒ Object
75
76
77
78
79
80
81
82
83
84
|
# File 'lib/sidekiq.rb', line 75
def self.redis=(hash)
if hash.is_a?(Hash)
@redis = RedisConnection.create(hash)
options[:namespace] ||= hash[:namespace]
elsif hash.is_a?(ConnectionPool)
@redis = hash
else
raise ArgumentError, "redis= requires a Hash or ConnectionPool"
end
end
|
.server? ⇒ Boolean
65
66
67
|
# File 'lib/sidekiq.rb', line 65
def self.server?
defined?(Sidekiq::CLI)
end
|
.server_middleware {|@server_chain| ... } ⇒ Object
92
93
94
95
96
|
# File 'lib/sidekiq.rb', line 92
def self.server_middleware
@server_chain ||= Processor.default_middleware
yield @server_chain if block_given?
@server_chain
end
|
.size(*queues) ⇒ Object
120
121
122
123
124
125
126
127
128
|
# File 'lib/sidekiq.rb', line 120
def self.size(*queues)
return Sidekiq::Stats.new.enqueued if queues.empty?
Sidekiq.redis { |conn|
conn.multi {
queues.map { |q| conn.llen("queue:#{q}") }
}
}.inject(0) { |memo, count| memo += count }
end
|
.❨╯°□°❩╯︵(┻━┻) ⇒ Object
30
31
32
|
# File 'lib/sidekiq.rb', line 30
def self.❨╯°□°❩╯︵ ┻━┻
puts "Calm down, bro"
end
|