Class: EventMachine::PeriodicTimer

Inherits:

Object

• Object
• EventMachine::PeriodicTimer

Defined in:

lib/eventmachine.rb

Overview

TODO, document this

Instance Attribute Summary

• #interval ⇒ Object

  Returns the value of attribute interval.

Instance Method Summary

• #cancel ⇒ Object
• #fire ⇒ Object
• #initialize(*args, &block) ⇒ PeriodicTimer constructor

  A new instance of PeriodicTimer.

• #schedule ⇒ Object

Constructor Details

#initialize(*args, &block) ⇒ PeriodicTimer

Returns a new instance of PeriodicTimer.

# File 'lib/eventmachine.rb', line 1556

def initialize *args, &block
	@interval = args.shift
	@code = args.shift || block
	schedule
end

Instance Attribute Details

#interval ⇒ Object

Returns the value of attribute interval.

# File 'lib/eventmachine.rb', line 1555

def interval
  @interval
end

Instance Method Details

#cancel ⇒ Object

# File 'lib/eventmachine.rb', line 1568

def cancel
	@cancelled = true
end

#fire ⇒ Object

# File 'lib/eventmachine.rb', line 1564

def fire
	@code.call
	schedule unless @cancelled
end

#schedule ⇒ Object

# File 'lib/eventmachine.rb', line 1561

def schedule
	EventMachine::add_timer @interval, proc {self.fire}
end