---

timer Class Reference

List of all members.

---

Detailed Description

An object that may be attached to an event loop to cause its fire() method to be called at a particular time.

Public Methods
	timer (io_event_loop &loop, ntime when=ntime::none())
	Constructor.
virtual	~timer ()
	Destructor.
void	arm (ntime when)
	Arms the timer for a particular point in time.
void	disarm ()
	Disarms the timer.
bool	is_armed ()
	Returns true if the timer is armed.
ntime	get_when ()
	Returns the time that the timer will fire (or ntime::none()) if unarmed.
Protected Methods
virtual void	fire ()=0
	Invoked by the event loop when the timer fires.
Friends
class	io_event_loop

---

Constructor & Destructor Documentation

timer::timer (  io_event_loop &    loop, ntime    when = ntime::none() )

Constructor.

virtual timer::~timer (    )  [virtual]

Destructor.

---

Member Function Documentation

void timer::arm (  ntime    when )

Arms the timer for a particular point in time. To disarm the timer, use arm(ntime::none()). To arm the timer for 1 millisecond in the future, use arm(ntime::now() + ntime::msec(1)).

void timer::disarm (    )

Disarms the timer.

virtual void timer::fire (    )  [protected, pure virtual]

Invoked by the event loop when the timer fires.

ntime timer::get_when (    )

Returns the time that the timer will fire (or ntime::none()) if unarmed.

bool timer::is_armed (    )

Returns true if the timer is armed.

---

Friends And Related Function Documentation

friend class io_event_loop [friend]

---

The documentation for this class was generated from the following file:

• ioevent

---