Class: Sidekiq::Queue

Inherits:
Object
  • Object
show all
Includes:
Enumerable, ApiUtils
Defined in:
lib/sidekiq/api.rb

Overview

Represents a queue within Sidekiq. Allows enumeration of all jobs within the queue and deletion of jobs. NB: this queue data is real-time and is changing within Redis moment by moment.

queue = Sidekiq::Queue.new("mailer")
queue.each do |job|
  job.klass # => 'MyWorker'
  job.args # => [1, 2, 3]
  job.delete if job.jid == 'abcdef1234567890'
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ApiUtils

#calculate_latency

Constructor Details

#initialize(name = "default") ⇒ Queue

Returns a new instance of Queue.

Parameters:

  • name (String) (defaults to: "default") —

    the name of the queue



301
302
303
304
 
# File 'lib/sidekiq/api.rb', line 301

def initialize(name = "default")
  @name = name.to_s
  @rname = "queue:#{name}"
end

Instance Attribute Details

#name ⇒ Object (readonly) Also known as: id

Returns the value of attribute name.



297
298
299
 
# File 'lib/sidekiq/api.rb', line 297

def name
  @name
end

Class Method Details

.all ⇒ Array<Sidekiq::Queue>

Fetch all known queues within Redis.

Returns:



293
294
295
 
# File 'lib/sidekiq/api.rb', line 293

def self.all
  Sidekiq.redis { |c| c.sscan("queues").to_a }.sort.map { |q| Sidekiq::Queue.new(q) }
end

Instance Method Details

#as_json(options = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

:nodoc:



383
384
385
 
# File 'lib/sidekiq/api.rb', line 383

def as_json(options = nil)
  {name: name} # 5336
end

#clear ⇒ Boolean Also known as: 💣

delete all jobs within this queue

Returns:

  • (Boolean) —

    true



370
371
372
373
374
375
376
377
378
 
# File 'lib/sidekiq/api.rb', line 370

def clear
  Sidekiq.redis do |conn|
    conn.multi do |transaction|
      transaction.unlink(@rname)
      transaction.srem("queues", [name])
    end
  end
  true
end

#each ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/sidekiq/api.rb', line 334

def each
  initial_size = size
  deleted_size = 0
  page = 0
  page_size = 50

  loop do
    range_start = page * page_size - deleted_size
    range_end = range_start + page_size - 1
    entries = Sidekiq.redis { |conn|
      conn.lrange @rname, range_start, range_end
    }
    break if entries.empty?
    page += 1
    entries.each do |entry|
      yield JobRecord.new(entry, @name)
    end
    deleted_size = initial_size - size
  end
end

#find_job(jid) ⇒ Sidekiq::JobRecord?

Find the job with the given JID within this queue.

This is a *slow, inefficient* operation. Do not use under normal conditions.

Parameters:

  • jid (String) —

    the job_id to look for

Returns:



364
365
366
 
# File 'lib/sidekiq/api.rb', line 364

def find_job(jid)
  detect { |j| j.jid == jid }
end

#latency ⇒ Float

Calculates this queue’s latency, the difference in seconds since the oldest job in the queue was enqueued.

Returns:

  • (Float) —

    in seconds



324
325
326
327
328
329
330
331
332
 
# File 'lib/sidekiq/api.rb', line 324

def latency
  entry = Sidekiq.redis { |conn|
    conn.lindex(@rname, -1)
  }
  return 0.0 unless entry

  job = Sidekiq.load_json(entry)
  calculate_latency(job)
end

#paused? ⇒ Boolean

Returns if the queue is currently paused.

Returns:

  • (Boolean) —

    if the queue is currently paused



315
316
317
 
# File 'lib/sidekiq/api.rb', line 315

def paused?
  false
end

#size ⇒ Integer

The current size of the queue within Redis. This value is real-time and can change between calls.

Returns:

  • (Integer) —

    the size



310
311
312
 
# File 'lib/sidekiq/api.rb', line 310

def size
  Sidekiq.redis { |con| con.llen(@rname) }
end