Module: Sidetiq::API
- Included in:
- Sidetiq
- Defined in:
- lib/sidetiq/api.rb
Overview
Public: Sidetiq API methods.
Instance Method Summary collapse
-
#retries(worker = nil, &block) ⇒ Object
Public: Recurring jobs currently scheduled for retries.
-
#scheduled(worker = nil, &block) ⇒ Object
Public: Currently scheduled recurring jobs.
-
#schedules ⇒ Object
Public: Returns a Hash of Sidetiq::Schedule instances.
-
#workers ⇒ Object
Public: Returns an Array of workers including Sidetiq::Schedulable.
Instance Method Details
#retries(worker = nil, &block) ⇒ Object
Public: Recurring jobs currently scheduled for retries.
worker - A Sidekiq::Worker class or String of the class name (optional) block - An optional block that can be given to which each
Sidekiq::SortedEntry instance corresponding to a scheduled job will
be yielded.
Examples
Sidetiq.retries
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.retries(MyWorker)
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.retries("MyWorker")
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.retries do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.retries(MyWorker) do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.retries("MyWorker") do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Yields each Sidekiq::SortedEntry instance. Returns an Array of Sidekiq::SortedEntry objects.
88 89 90 |
# File 'lib/sidetiq/api.rb', line 88 def retries(worker = nil, &block) filter_set(Sidekiq::RetrySet.new, worker, &block) end |
#scheduled(worker = nil, &block) ⇒ Object
Public: Currently scheduled recurring jobs.
worker - A Sidekiq::Worker class or String of the class name (optional) block - An optional block that can be given to which each
Sidekiq::SortedEntry instance corresponding to a scheduled job will
be yielded.
Examples
Sidetiq.scheduled
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.scheduled(MyWorker)
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.scheduled("MyWorker")
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.scheduled do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.scheduled(MyWorker) do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Sidetiq.scheduled("MyWorker") do |job|
# do stuff ...
end
# => [#<Sidekiq::SortedEntry>, ...]
Yields each Sidekiq::SortedEntry instance. Returns an Array of Sidekiq::SortedEntry objects.
49 50 51 |
# File 'lib/sidetiq/api.rb', line 49 def scheduled(worker = nil, &block) filter_set(Sidekiq::ScheduledSet.new, worker, &block) end |
#schedules ⇒ Object
Public: Returns a Hash of Sidetiq::Schedule instances.
10 11 12 |
# File 'lib/sidetiq/api.rb', line 10 def schedules workers.map(&:schedule) end |
#workers ⇒ Object
Public: Returns an Array of workers including Sidetiq::Schedulable.
5 6 7 |
# File 'lib/sidetiq/api.rb', line 5 def workers Sidetiq::Schedulable.subclasses(true) end |