Class: Timers::Wait
- Inherits:
-
Object
- Object
- Timers::Wait
- Defined in:
- lib/timers/wait.rb
Overview
An exclusive, monotonic timeout class.
Instance Attribute Summary collapse
-
#duration ⇒ Object
readonly
Returns the value of attribute duration.
-
#remaining ⇒ Object
readonly
Returns the value of attribute remaining.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(duration) ⇒ Wait
constructor
A new instance of Wait.
-
#while_time_remaining ⇒ Object
Yields while time remains for work to be done:.
Constructor Details
#initialize(duration) ⇒ Wait
Returns a new instance of Wait.
20 21 22 23 |
# File 'lib/timers/wait.rb', line 20 def initialize(duration) @duration = duration @remaining = true end |
Instance Attribute Details
#duration ⇒ Object (readonly)
Returns the value of attribute duration.
25 26 27 |
# File 'lib/timers/wait.rb', line 25 def duration @duration end |
#remaining ⇒ Object (readonly)
Returns the value of attribute remaining.
26 27 28 |
# File 'lib/timers/wait.rb', line 26 def remaining @remaining end |
Class Method Details
.for(duration, &block) ⇒ Object
8 9 10 11 12 13 14 15 16 17 18 |
# File 'lib/timers/wait.rb', line 8 def self.for(duration, &block) if duration timeout = new(duration) timeout.while_time_remaining(&block) else loop do yield(nil) end end end |
Instance Method Details
#while_time_remaining ⇒ Object
Yields while time remains for work to be done:
29 30 31 32 33 34 35 36 37 |
# File 'lib/timers/wait.rb', line 29 def while_time_remaining @interval = Hitimes::Interval.new @interval.start yield @remaining while time_remaining? ensure @interval.stop @interval = nil end |