Class: WaitFor::Timer

Inherits:

Object

• Object
• WaitFor::Timer

Defined in:

lib/waitfor/timer.rb

Instance Method Summary

• #initialize(options) ⇒ Timer constructor

  A new instance of Timer.

• #out_of_time? ⇒ Boolean

  Returns whether the elapsed time has surpassed the allotted time.

Constructor Details

#initialize(options) ⇒ Timer

A new instance of Timer.

Parameters:

• options (Hash) —

  for Timer configuration such as ‘:seconds`, `:minutes`, `:exception` and `:message`

# File 'lib/waitfor/timer.rb', line 7

def initialize( options )
  @config = WaitFor::Settings::Configuration.new( options )
  @start_time = Time.now
end

Instance Method Details

#out_of_time? ⇒ Boolean

Returns whether the elapsed time has surpassed the allotted time

Returns:

• (Boolean) —

  of elapsed time is greater or equal to the set number of seconds

Raises:

• (WaitFor::TimeoutError) —

  Timeout error if time limit is reached

# File 'lib/waitfor/timer.rb', line 16

def out_of_time?
  raise_exception if timed_out?
  false
end