Class: Timers::Timer

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/timers/timer.rb

Overview

An individual timer set to fire a given proc at a given time. A timer is always connected to a Timer::Group but it would ONLY be in @group.timers if it also has a @handle specified. Otherwise it is either PAUSED or has been FIRED and is not recurring. You can manually enter this state by calling #cancel and resume normal operation by calling #reset.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group, interval, recurring = false, offset = nil, &block) ⇒ Timer

Returns a new instance of Timer.



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/timers/timer.rb', line 18

def initialize(group, interval, recurring = false, offset = nil, &block)
	@group = group

	@interval = interval
	@recurring = recurring
	@block = block
	@offset = offset

	@handle = nil

	# If a start offset was supplied, use that, otherwise use the current timers offset.
	reset(@offset || @group.current_offset)
end

Instance Attribute Details

#interval ⇒ Object (readonly)

Returns the value of attribute interval.



16
17
18
 
# File 'lib/timers/timer.rb', line 16

def interval
  @interval
end

#offset ⇒ Object (readonly)

Returns the value of attribute offset.



16
17
18
 
# File 'lib/timers/timer.rb', line 16

def offset
  @offset
end

#recurring ⇒ Object (readonly)

Returns the value of attribute recurring.



16
17
18
 
# File 'lib/timers/timer.rb', line 16

def recurring
  @recurring
end

Instance Method Details

#cancel ⇒ Object

Cancel this timer. Do not call while paused.



67
68
69
70
71
72
73
74
75
 
# File 'lib/timers/timer.rb', line 67

def cancel
	return unless @handle

	@handle.cancel! if @handle
	@handle = nil

	# This timer is no longer valid:
	@group.timers.delete self if @group
end

#delay(seconds) ⇒ Object

Extend this timer



58
59
60
61
62
63
64
 
# File 'lib/timers/timer.rb', line 58

def delay(seconds)
	@handle.cancel! if @handle

	@offset += seconds

	@handle = @group.events.schedule(@offset, self)
end

#fire(offset = @group.current_offset) ⇒ Object Also known as: call

Fire the block.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/timers/timer.rb', line 94

def fire(offset = @group.current_offset)
	if recurring == :strict
		# ... make the next interval strictly the last offset + the interval:
		reset(@offset)
	elsif recurring
		reset(offset)
	else
		@offset = offset
	end

	@block.call(offset, self)

	cancel unless recurring
end

#fires_in ⇒ Object

Number of seconds until next fire / since last fire



112
113
114
 
# File 'lib/timers/timer.rb', line 112

def fires_in
	@offset - @group.current_offset if @offset
end

#inspect ⇒ Object

Inspect a timer



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/timers/timer.rb', line 117

def inspect
	str = "#{to_s[0..-2]} ".dup

	if @offset
		str << if fires_in >= 0
						 "fires in #{fires_in} seconds"
					 else
						 "fired #{fires_in.abs} seconds ago"
					 end

		str << ", recurs every #{interval}" if recurring
	else
		str << "dead"
	end

	str << ">"
end

#pause ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/timers/timer.rb', line 36

def pause
	return if paused?

	@group.timers.delete self
	@group.paused_timers.add self

	@handle.cancel! if @handle
	@handle = nil
end

#paused? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/timers/timer.rb', line 32

def paused?
	@group.paused_timers.include? self
end

#reset(offset = @group.current_offset) ⇒ Object

Reset this timer. Do not call while paused.

Parameters:

  • offset (Numeric) (defaults to: @group.current_offset) —

    the duration to add to the timer.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/timers/timer.rb', line 79

def reset(offset = @group.current_offset)
	# This logic allows us to minimise the interaction with @group.timers.
	# A timer with a handle is always registered with the group.
	if @handle
		@handle.cancel!
	else
		@group.timers << self
	end

	@offset = Float(offset) + @interval

	@handle = @group.events.schedule(@offset, self)
end

#resume ⇒ Object Also known as: continue 



46
47
48
49
50
51
52
53
 
# File 'lib/timers/timer.rb', line 46

def resume
	return unless paused?

	@group.paused_timers.delete self

	# This will add us back to the group:
	reset
end