Class: Sidekiq::Queue
- Inherits:
-
Object
- Object
- Sidekiq::Queue
- Extended by:
- RedisScanner
- Includes:
- Enumerable
- Defined in:
- lib/sidekiq/api.rb
Overview
Instance Attribute Summary collapse
-
#name ⇒ Object
readonly
Returns the value of attribute name.
Class Method Summary collapse
-
.all ⇒ Object
Return all known queues within Redis.
Instance Method Summary collapse
- #clear ⇒ Object (also: #💣)
- #each ⇒ Object
-
#find_job(jid) ⇒ Object
Find the job with the given JID within this queue.
-
#initialize(name = "default") ⇒ Queue
constructor
A new instance of Queue.
-
#latency ⇒ Object
Calculates this queue’s latency, the difference in seconds since the oldest job in the queue was enqueued.
-
#paused? ⇒ Boolean
Sidekiq Pro overrides this.
- #size ⇒ Object
Methods included from RedisScanner
Constructor Details
#initialize(name = "default") ⇒ Queue
Returns a new instance of Queue.
236 237 238 239 |
# File 'lib/sidekiq/api.rb', line 236 def initialize(name="default") @name = name.to_s @rname = "queue:#{name}" end |
Instance Attribute Details
#name ⇒ Object (readonly)
Returns the value of attribute name.
234 235 236 |
# File 'lib/sidekiq/api.rb', line 234 def name @name end |
Class Method Details
Instance Method Details
#clear ⇒ Object Also known as: 💣
296 297 298 299 300 301 302 303 |
# File 'lib/sidekiq/api.rb', line 296 def clear Sidekiq.redis do |conn| conn.multi do conn.del(@rname) conn.srem("queues", name) end end end |
#each ⇒ Object
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/sidekiq/api.rb', line 266 def each initial_size = size deleted_size = 0 page = 0 page_size = 50 while true do range_start = page * page_size - deleted_size range_end = range_start + page_size - 1 entries = Sidekiq.redis do |conn| conn.lrange @rname, range_start, range_end end break if entries.empty? page += 1 entries.each do |entry| yield Job.new(entry, @name) end deleted_size = initial_size - size end end |
#find_job(jid) ⇒ Object
Find the job with the given JID within this queue.
This is a slow, inefficient operation. Do not use under normal conditions. Sidekiq Pro contains a faster version.
292 293 294 |
# File 'lib/sidekiq/api.rb', line 292 def find_job(jid) detect { |j| j.jid == jid } end |
#latency ⇒ Object
Calculates this queue’s latency, the difference in seconds since the oldest job in the queue was enqueued.
255 256 257 258 259 260 261 262 263 264 |
# File 'lib/sidekiq/api.rb', line 255 def latency entry = Sidekiq.redis do |conn| conn.lrange(@rname, -1, -1) end.first return 0 unless entry job = Sidekiq.load_json(entry) now = Time.now.to_f thence = job['enqueued_at'] || now now - thence end |
#paused? ⇒ Boolean
Sidekiq Pro overrides this
246 247 248 |
# File 'lib/sidekiq/api.rb', line 246 def paused? false end |