Class: Cinch::Timer

Inherits:

Object

• Object
• Cinch::Timer

show all

Includes:

Helpers

Defined in:

lib/cinch/timer.rb

Overview

Instance Attribute Summary (collapse)

• - (Proc) block readonly
• - (Bot) bot readonly
• - (Numeric) interval

  The interval (in seconds) of the timer.

• - (Integer) shots

  The remaining number of shots before this timer will stop.

• - (Boolean) started (also: #started?) readonly
• - (ThreadGroup) thread_group readonly private
• - (Boolean) threaded (also: #threaded?)

  If true, each invocation will be executed in a thread of its own.

Instance Method Summary (collapse)

• - (Timer) initialize(bot, options, &block) constructor

  A new instance of Timer.

• - start

  Start the timer.

• - stop

  Stop the timer.

• - (Boolean) stopped?
• - (String) to_s

Methods included from Helpers

#Channel, #Format, #Target, #Timer, #User, #debug, #error, #exception, #fatal, #incoming, #info, #log, #outgoing, #rescue_exception, #warn

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# File 'lib/cinch/timer.rb', line 64

def initialize(bot, options, &block)
  options = {:threaded => true, :shots => Float::INFINITY, :start_automatically => true, :stop_automatically => true}.merge(options)

  @bot        = bot
  @interval   = options[:interval].to_f
  @threaded   = options[:threaded]
  @orig_shots = options[:shots]
  # Setting @shots here so the attr_reader won't return nil
  @shots      = @orig_shots
  @block      = block

  @started = false
  @thread_group = ThreadGroup.new

  if options[:start_automatically]
    @bot.on :connect, //, self do |m, timer|
      timer.start
    end
  end

  if options[:stop_automatically]
    @bot.on :disconnect, //, self do |m, timer|
      timer.stop
    end
  end
end

35
36
37

# File 'lib/cinch/timer.rb', line 35

def block
  @block
end

25
26
27

# File 'lib/cinch/timer.rb', line 25

def bot
  @bot
end

28
29
30

# File 'lib/cinch/timer.rb', line 28

def interval
  @interval
end

43
44
45

# File 'lib/cinch/timer.rb', line 43

def shots
  @shots
end

38
39
40

# File 'lib/cinch/timer.rb', line 38

def started
  @started
end

49
50
51

# File 'lib/cinch/timer.rb', line 49

def thread_group
  @thread_group
end

32
33
34

# File 'lib/cinch/timer.rb', line 32

def threaded
  @threaded
end

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# File 'lib/cinch/timer.rb', line 99

def start
  return if @started

  @bot.loggers.debug "[timer] Starting timer #{self}"

  @shots = @orig_shots

  @thread_group.add Thread.new {
    while @shots > 0 do
      sleep @interval
      if threaded?
        Thread.new do
          rescue_exception do
            @block.call
          end
        end
      else
        rescue_exception do
          @block.call
        end
      end

      @shots -= 1
    end
  }

  @started = true
end

131
132
133
134
135
136
137
138

# File 'lib/cinch/timer.rb', line 131

def stop
  return unless @started

  @bot.loggers.debug "[timer] Stopping timer #{self}"

  @thread_group.list.each { |thread| thread.kill }
  @started = false
end

92
93
94

# File 'lib/cinch/timer.rb', line 92

def stopped?
  !@started
end

141
142
143

# File 'lib/cinch/timer.rb', line 141

def to_s
  "<Cinch::Timer %s/%s shots, %ds interval, %sthreaded, %sstarted, block: %s>" % [@orig_shots - @shots, @orig_shots, @interval, @threaded ? "" : "not ", @started ? "" : "not ", @block]
end