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



199
200
201
202
# File 'lib/sidekiq/api.rb', line 199

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

Instance Attribute Details

#nameObject (readonly)

Returns the value of attribute name



197
198
199
# File 'lib/sidekiq/api.rb', line 197

def name
  @name
end

Class Method Details

.allObject



193
194
195
# File 'lib/sidekiq/api.rb', line 193

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

Instance Method Details

#clearObject Also known as: 💣



246
247
248
249
250
251
252
253
# File 'lib/sidekiq/api.rb', line 246

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

#eachObject



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/sidekiq/api.rb', line 221

def each
  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|
      yield Job.new(entry, @name)
    end
    deleted_size = initial_size - size
  end
end

#find_job(jid) ⇒ Object



242
243
244
# File 'lib/sidekiq/api.rb', line 242

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

#latencyObject



213
214
215
216
217
218
219
# File 'lib/sidekiq/api.rb', line 213

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)


209
210
211
# File 'lib/sidekiq/api.rb', line 209

def paused?
  false
end

#sizeObject



204
205
206
# File 'lib/sidekiq/api.rb', line 204

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