class XorpTimer

XorpTimer class. More...

Definition#include <timer.hh>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods


Detailed Description

Timers allow callbacks to be made at a specific time in the future. They are ordinarily created via TimerList methods, and they must be associated with an TimerList object in order to be runnable.

See also: TimerList

bool  scheduled ()

scheduled

[const]

Returns: true if XorpTimer is associated with a TimerList and has an expiry time in the future.

const timeval&  expiry ()

expiry

[const]

Returns: the expiry time of the XorpTimer

void  schedule_now ()

schedule_now

Expire the XorpTimer object when the TimerList is next run.

void  schedule_at (const timeval& when)

schedule_at

Schedule the XorpTimer object at a given time.

void  schedule_after_ms (int ms)

schedule_after_ms

Schedule the XorpTimer object.

Parameters:
msmilliseconds from the current time.

void  reschedule_after_ms (int ms)

reschedule_after_ms

Reschedule the XorpTimer object.

Parameters:
msmilliseconds from the most recent expiry.

void  unschedule ()

unschedule

Unschedule the XorpTimer object. The XorpTimer callback is not invoked.

void  clear ()

clear

Release reference to underlying state.

bool  initialized ()

initialized

[const]

Returns: true if XorpTimer object has underlying state.

bool  is_valid ()

is_valid

[const]

Equivalent to initialized.

 XorpTimer ()

XorpTimer

 XorpTimer (TimerList* list, BasicTimerCallback cb)

XorpTimer

 XorpTimer (const XorpTimer&)

XorpTimer

 ~XorpTimer ()

~XorpTimer

XorpTimer&  operator= (const XorpTimer&)

operator=

TimerNode*  node ()

node

[const]


Generated by: pavlin on possum.icir.org on Mon Mar 10 19:34:43 2003, using kdoc 2.0a54+XORP.