UCommon
|
A timer queue for timer events. More...
#include <timers.h>
Data Structures | |
class | event |
A timer event object that lives on a timer queue. More... | |
Public Member Functions | |
timeout_t | expire () |
Process timer queue and find when next event triggers. | |
void | operator+= (event &timer) |
Add a timer event to the timer queue. | |
void | operator-= (event &timer) |
Remove a timer event from the timer queue. | |
TimerQueue () | |
Create an empty timer queue. | |
virtual | ~TimerQueue () |
Destroy queue, does not remove event objects. | |
Protected Member Functions | |
virtual void | modify (void)=0 |
Called in derived class when the queue is being modified. | |
virtual void | update (void)=0 |
Called in derived class after the queue has been modified. | |
Friends | |
class | event |
A timer queue for timer events.
The timer queue is used to hold a linked list of timers that must be processed together. The timer queue processes the timer event list and calls an expired function on events that have expired. The timer queue also determines the wait time until the next timer will expire. When timer events are modified, they can retrigger the queue to re-examine the list to find when the next timer will now expire.
timeout_t ucommon::TimerQueue::expire | ( | ) |
Process timer queue and find when next event triggers.
This function will call the expired methods on expired timers. Normally this function will be called in the context of a timer thread which sleeps for the timeout returned unless it is awoken on an update event.
virtual void ucommon::TimerQueue::modify | ( | void | ) | [protected, pure virtual] |
Called in derived class when the queue is being modified.
This is often used to lock the list.
void ucommon::TimerQueue::operator+= | ( | event & | timer | ) |
Add a timer event to the timer queue.
timer | event to add. |
void ucommon::TimerQueue::operator-= | ( | event & | timer | ) |
Remove a timer event from the timer queue.
timer | event to remove. |
virtual void ucommon::TimerQueue::update | ( | void | ) | [protected, pure virtual] |
Called in derived class after the queue has been modified.
This often releases a lock that modify set and to wakeup a timer thread to evaluate when the next timer will now expire.