class XorpTimer XorpTimer class. More... Definition #include <timer.hh> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

• bool  scheduled () const
• const TimeVal&  expiry () const
• bool  time_remaining (TimeVal& remain) const
• void  schedule_now ()
• void  schedule_at (const TimeVal& when)
• void  schedule_after (const TimeVal& wait)
• void  schedule_after_ms (int ms)
• void  reschedule_after_ms (int ms)
• void  unschedule ()
• void  clear ()
•  XorpTimer ()
•  XorpTimer (TimerList* list, BasicTimerCallback cb)
•  XorpTimer (const XorpTimer&)
•  ~XorpTimer ()
• XorpTimer&  operator= (const XorpTimer&)
• TimerNode*  node () const

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

[const]

Returns: true if the timer has been scheduled, and the callback associated with this timer has not been called yet.

[const]

Returns: the expiry time of the XorpTimer

[const]

Get the remaining time until the timer expires.

Parameters:

remain

the return-by-reference value with the remaining time until the timer expires. If the current time is beyond the expire time (e.g., if we are behind schedule with the timer processing), the return time is zero.

Returns: true if the remaining time has meaningful value (e.g., if timer was scheduled), otherwise false.

Expire the XorpTimer object when the TimerList is next run.

Schedule the XorpTimer object at a given time.

Schedule the XorpTimer object to expire in wait after the current time.

Schedule the XorpTimer object.

Parameters:

ms	milliseconds from the current time.

Reschedule the XorpTimer object.

Parameters:

ms	milliseconds from the most recent expiry.

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

Release reference to underlying state.

[const]