Class: Sidekiq::Manager

Inherits:
Object
  • Object
show all
Includes:
Actor, Util
Defined in:
lib/sidekiq/manager.rb

Overview

The main router in the system. This manages the processor state and accepts messages from Redis to be dispatched to an idle processor.

Constant Summary

Constants included from Actor

Actor::TaskThread

Constants included from Util

Util::EXPIRY

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Actor

#after, #alive?, #async, #current_actor, #defer, included, #signal, #sleep, #terminate, #watchdog

Methods included from Util

#hostname, #logger, #process_id, #redis, #watchdog

Methods included from ExceptionHandler

#handle_exception

Constructor Details

#initialize(options = {}) ⇒ Manager

Returns a new instance of Manager.



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/sidekiq/manager.rb', line 22

def initialize(options={})
  logger.debug { options.inspect }
  @count = options[:concurrency] || 25
  @done_callback = nil

  @in_progress = {}
  @done = false
  @busy = []
  @fetcher = Fetcher.new(current_actor, options)
  @ready = @count.times.map { Processor.new_link(current_actor) }
end

Instance Attribute Details

#busy ⇒ Object (readonly)

Returns the value of attribute busy.



19
20
21
 
# File 'lib/sidekiq/manager.rb', line 19

def busy
  @busy
end

#fetcher ⇒ Object

Returns the value of attribute fetcher.



20
21
22
 
# File 'lib/sidekiq/manager.rb', line 20

def fetcher
  @fetcher
end

#ready ⇒ Object (readonly)

Returns the value of attribute ready.



18
19
20
 
# File 'lib/sidekiq/manager.rb', line 18

def ready
  @ready
end

Instance Method Details

#assign(work) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/sidekiq/manager.rb', line 91

def assign(work)
  watchdog("Manager#assign died") do
    if stopped?
      # Race condition between Manager#stop if Fetcher
      # is blocked on redis and gets a message after
      # all the ready Processors have been stopped.
      # Push the message back to redis.
      work.requeue
    else
      processor = @ready.pop
      @in_progress[processor.object_id] = work
      @busy << processor
      processor.async.process(work)
    end
  end
end

#processor_died(processor, reason) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sidekiq/manager.rb', line 77

def processor_died(processor, reason)
  watchdog("Manager#processor_died died") do
    @in_progress.delete(processor.object_id)
    @busy.delete(processor)

    unless stopped?
      @ready << Processor.new_link(current_actor)
      dispatch
    else
      signal(:shutdown) if @busy.empty?
    end
  end
end

#processor_done(processor) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/sidekiq/manager.rb', line 62

def processor_done(processor)
  watchdog('Manager#processor_done died') do
    @done_callback.call(processor) if @done_callback
    @in_progress.delete(processor.object_id)
    @busy.delete(processor)
    if stopped?
      processor.terminate if processor.alive?
      signal(:shutdown) if @busy.empty?
    else
      @ready << processor if processor.alive?
    end
    dispatch
  end
end

#procline(tag) ⇒ Object 



108
109
110
 
# File 'lib/sidekiq/manager.rb', line 108

def procline(tag)
  "sidekiq #{Sidekiq::VERSION} #{tag}[#{@busy.size} of #{@count} busy]#{stopped? ? ' stopping' : ''}"
end

#start ⇒ Object 



54
55
56
 
# File 'lib/sidekiq/manager.rb', line 54

def start
  @ready.each { dispatch }
end

#stop(options = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/sidekiq/manager.rb', line 34

def stop(options={})
  watchdog('Manager#stop died') do
    shutdown = options[:shutdown]
    timeout = options[:timeout]

    @done = true
    Sidekiq::Fetcher.done!
    @fetcher.async.terminate if @fetcher.alive?

    logger.info { "Shutting down #{@ready.size} quiet workers" }
    @ready.each { |x| x.terminate if x.alive? }
    @ready.clear

    clear_worker_set

    return after(0) { signal(:shutdown) } if @busy.empty?
    hard_shutdown_in timeout if shutdown
  end
end

#when_done(&blk) ⇒ Object 



58
59
60
 
# File 'lib/sidekiq/manager.rb', line 58

def when_done(&blk)
  @done_callback = blk
end