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, #bid, #created_at, #display_args, #display_class, #enqueued_at, #error_backtrace, #jid, #klass, #latency, #tags

Instance Attribute Details

#parentObject (readonly)

Returns the value of attribute parent.



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

def parent
  @parent
end

#scoreObject (readonly)

Returns the value of attribute score.



505
506
507
# File 'lib/sidekiq/api.rb', line 505

def score
  @score
end

Instance Method Details

#add_to_queueObject

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



541
542
543
544
545
546
# File 'lib/sidekiq/api.rb', line 541

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

#atObject

The timestamp associated with this entry



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

def at
  Time.at(score).utc
end

#deleteObject

remove this entry from the sorted set



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

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

#error?Boolean

Returns:

  • (Boolean)


565
566
567
# File 'lib/sidekiq/api.rb', line 565

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

#killObject

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



559
560
561
562
563
# File 'lib/sidekiq/api.rb', line 559

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



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

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

#retryObject

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



550
551
552
553
554
555
556
# File 'lib/sidekiq/api.rb', line 550

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