Class: Sidekiq::SortedEntry

Inherits:
JobRecord show all
Defined in:
lib/sidekiq/api.rb

Overview

Represents a job within a Redis sorted set where the score represents a timestamp associated with the job. This timestamp could be the scheduled time for it to run (e.g. scheduled set), or the expiration date after which the entry should be deleted (e.g. dead set).

Instance Attribute Summary collapse

Attributes inherited from JobRecord

#Item, #Queue, #Value, #item, #queue, #value

Instance Method Summary collapse

Methods inherited from JobRecord

#[], #args, #created_at, #display_args, #display_class, #enqueued_at, #error_backtrace, #jid, #klass, #latency, #tags

Instance Attribute Details

#parent ⇒ Object (readonly)

Returns the value of attribute parent.


479
480
481
 
# File 'lib/sidekiq/api.rb', line 479

def parent
  @parent
end

#score ⇒ Object (readonly)

Returns the value of attribute score.


478
479
480
 
# File 'lib/sidekiq/api.rb', line 478

def score
  @score
end

Instance Method Details

#add_to_queue ⇒ Object

Enqueue this job from the scheduled or dead set so it will be executed at some point in the near future.


514
515
516
517
518
519
 
# File 'lib/sidekiq/api.rb', line 514

def add_to_queue
  remove_job do |message|
    msg = Sidekiq.load_json(message)
    Sidekiq::Client.push(msg)
  end
end

#at ⇒ Object

The timestamp associated with this entry


490
491
492
 
# File 'lib/sidekiq/api.rb', line 490

def at
  Time.at(score).utc
end

#delete ⇒ Object

remove this entry from the sorted set


495
496
497
498
499
500
501
 
# File 'lib/sidekiq/api.rb', line 495

def delete
  if @value
    @parent.delete_by_value(@parent.name, @value)
  else
    @parent.delete_by_jid(score, jid)
  end
end

#error? ⇒ Boolean

Returns:

  • (Boolean) 

538
539
540
 
# File 'lib/sidekiq/api.rb', line 538

def error?
  !!item["error_class"]
end

#kill ⇒ Object

Move this job from its current set into the Dead set.


532
533
534
535
536
 
# File 'lib/sidekiq/api.rb', line 532

def kill
  remove_job do |message|
    DeadSet.new.kill(message)
  end
end

#reschedule(at) ⇒ Object

Change the scheduled time for this job.

Parameters:

  • at (Time) —

    the new timestamp for this job


506
507
508
509
510
 
# File 'lib/sidekiq/api.rb', line 506

def reschedule(at)
  Sidekiq.redis do |conn|
    conn.zincrby(@parent.name, at.to_f - @score, Sidekiq.dump_json(@item))
  end
end

#retry ⇒ Object

enqueue this job from the retry set so it will be executed at some point in the near future.


523
524
525
526
527
528
529
 
# File 'lib/sidekiq/api.rb', line 523

def retry
  remove_job do |message|
    msg = Sidekiq.load_json(message)
    msg["retry_count"] -= 1 if msg["retry_count"]
    Sidekiq::Client.push(msg)
  end
end