Class: Sidekiq::Job
- Inherits:
-
Object
- Object
- Sidekiq::Job
- Defined in:
- lib/sidekiq/api.rb
Overview
Encapsulates a pending job within a Sidekiq queue or sorted set.
The job should be considered immutable but may be removed from the queue via Job#delete.
Direct Known Subclasses
Instance Attribute Summary collapse
-
#item ⇒ Object
readonly
Returns the value of attribute item.
Instance Method Summary collapse
- #[](name) ⇒ Object
- #args ⇒ Object
-
#delete ⇒ Object
Remove this job from the queue.
- #enqueued_at ⇒ Object
-
#initialize(item, queue_name = nil) ⇒ Job
constructor
A new instance of Job.
- #jid ⇒ Object
- #klass ⇒ Object
- #latency ⇒ Object
- #queue ⇒ Object
Constructor Details
Instance Attribute Details
#item ⇒ Object (readonly)
Returns the value of attribute item.
192 193 194 |
# File 'lib/sidekiq/api.rb', line 192 def item @item end |
Instance Method Details
#[](name) ⇒ Object
233 234 235 |
# File 'lib/sidekiq/api.rb', line 233 def [](name) @item.__send__(:[], name) end |
#args ⇒ Object
204 205 206 |
# File 'lib/sidekiq/api.rb', line 204 def args @item['args'] end |
#delete ⇒ Object
Remove this job from the queue.
226 227 228 229 230 231 |
# File 'lib/sidekiq/api.rb', line 226 def delete count = Sidekiq.redis do |conn| conn.lrem("queue:#{@queue}", 1, @value) end count != 0 end |
#enqueued_at ⇒ Object
212 213 214 |
# File 'lib/sidekiq/api.rb', line 212 def enqueued_at Time.at(@item['enqueued_at'] || 0).utc end |
#jid ⇒ Object
208 209 210 |
# File 'lib/sidekiq/api.rb', line 208 def jid @item['jid'] end |
#klass ⇒ Object
200 201 202 |
# File 'lib/sidekiq/api.rb', line 200 def klass @item['class'] end |
#latency ⇒ Object
220 221 222 |
# File 'lib/sidekiq/api.rb', line 220 def latency Time.now.to_f - @item['enqueued_at'] end |
#queue ⇒ Object
216 217 218 |
# File 'lib/sidekiq/api.rb', line 216 def queue @queue end |