Class: Sidekiq::Queue

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

Overview

Encapsulates a queue within Sidekiq. Allows enumeration of all jobs within the queue and deletion of jobs.

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

Constructor Details

#initialize(name = "default") ⇒ Queue

Returns a new instance of Queue.



126
127
128
129
 
# File 'lib/sidekiq/api.rb', line 126

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

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



124
125
126
 
# File 'lib/sidekiq/api.rb', line 124

def name
  @name
end

Class Method Details

.all ⇒ Object 



120
121
122
 
# File 'lib/sidekiq/api.rb', line 120

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

Instance Method Details

#clear ⇒ Object Also known as: 💣 



173
174
175
176
177
178
179
180
 
# File 'lib/sidekiq/api.rb', line 173

def clear
  Sidekiq.redis do |conn|
    conn.multi do
      conn.del(@rname)
      conn.srem("queues", name)
    end
  end
end

#each(&block) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sidekiq/api.rb', line 148

def each(&block)
  initial_size = size
  deleted_size = 0
  page = 0
  page_size = 50

  loop do
    range_start = page * page_size - deleted_size
    range_end   = page * page_size - deleted_size + (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|
      block.call Job.new(entry, @name)
    end
    deleted_size = initial_size - size
  end
end

#find_job(jid) ⇒ Object 



169
170
171
 
# File 'lib/sidekiq/api.rb', line 169

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

#latency ⇒ Object 



140
141
142
143
144
145
146
 
# File 'lib/sidekiq/api.rb', line 140

def latency
  entry = Sidekiq.redis do |conn|
    conn.lrange(@rname, -1, -1)
  end.first
  return 0 unless entry
  Time.now.to_f - Sidekiq.load_json(entry)['enqueued_at']
end

#paused? ⇒ Boolean

Sidekiq Pro overrides this

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/sidekiq/api.rb', line 136

def paused?
  false
end

#size ⇒ Object 



131
132
133
 
# File 'lib/sidekiq/api.rb', line 131

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