Public Member Functions |
void | arm (timeout_t timeout) |
| Arm event to trigger at specified timeout.
|
void | attach (TimerQueue *queue) |
| Attach event to a timer queue.
|
void | detach (void) |
| Detach event from a timer queue.
|
void | disarm (void) |
| Disarm event.
|
timeout_t | get (void) const |
| Time remaining until expired.
|
TimerQueue * | getQueue (void) |
| Get the timer queue we are attached to.
|
bool | isExpired (void) |
| Test if event has expired.
|
void | update (void) |
| Notify timer queue that the timer has been updated.
|
virtual | ~event () |
| Detaches from queue when destroyed.
|
Protected Member Functions |
| event (timeout_t expire) |
| Construct a timer event object and initially arm.
|
| event (TimerQueue *queue, timeout_t expire) |
| Construct an armed timer event object and attach to queue.
|
virtual void | expired (void)=0 |
| Event method to call in derived class when timer expires.
|
virtual timeout_t | timeout (void) |
| Expected next timeout for the timer.
|
Friends |
class | TimerQueue |
A timer event object that lives on a timer queue.
Timer events are triggered through the timer queue's expire method. Timer events also modify the queue when they are changed, particularly to force re-evaluation of the expiration period. This class is not used by itself but rather as a base class for a timer event object.
- Author:
- David Sugar <dyfet@gnutelephony.org>
Definition at line 280 of file timers.h.