Provides a Timing Wheel version of ACE_Timer_Queue.
More...
#include <Timer_Wheel_T.h>
|
| ACE_Timer_Wheel_T (FUNCTOR *upcall_functor=0, FreeList *freelist=0, TIME_POLICY const &time_policy=TIME_POLICY()) |
| Default constructor. More...
|
|
| ACE_Timer_Wheel_T (u_int spoke_count, u_int resolution, size_t prealloc=0, FUNCTOR *upcall_functor=0, FreeList *freelist=0, TIME_POLICY const &time_policy=TIME_POLICY()) |
| Constructor with opportunities to set the wheelsize and resolution. More...
|
|
virtual | ~ACE_Timer_Wheel_T (void) |
| Destructor. More...
|
|
virtual bool | is_empty (void) const |
| True if queue is empty, else false. More...
|
|
virtual const ACE_Time_Value & | earliest_time (void) const |
|
virtual int | reset_interval (long timer_id, const ACE_Time_Value &interval) |
|
virtual int | cancel (const TYPE &type, int dont_call_handle_close=1) |
|
virtual int | cancel (long timer_id, const void **act=0, int dont_call_handle_close=1) |
|
virtual int | close (void) |
|
virtual int | expire (void) |
|
int | expire (const ACE_Time_Value ¤t_time) |
|
virtual ACE_Timer_Queue_Iterator_T< TYPE > & | iter (void) |
| Returns a pointer to this <ACE_Timer_Queue_T>'s iterator. More...
|
|
virtual ACE_Timer_Node_T< TYPE > * | remove_first (void) |
| Removes the earliest node from the queue and returns it. More...
|
|
virtual void | dump (void) const |
| Dump the state of an object. More...
|
|
virtual ACE_Timer_Node_T< TYPE > * | get_first (void) |
| Reads the earliest node from the queue and returns it. More...
|
|
template<class TYPE, class FUNCTOR, class ACE_LOCK, typename TIME_POLICY = ACE_Default_Time_Policy>
class ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >
Provides a Timing Wheel version of ACE_Timer_Queue.
This implementation uses a hash table of ordered doubly- linked lists of absolute times. The enhancements over the ACE_Timer_List
include adding a free list and the ability to preallocate nodes. Timer Wheel is based on the timing wheel implementation used in Adam M. Costello and George Varghese's paper "Redesigning the BSD Callout and
Timer Facilities" (http://dworkin.wustl.edu/~varghese/PAPERS/newbsd.ps.Z)
◆ Base_Timer_Queue
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ FreeList
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ Iterator
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ Node
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ ACE_Timer_Wheel_T() [1/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Default constructor.
Default Constructor that sets defaults for spoke_count_ and resolution_ and doesn't do any preallocation.
- Parameters
-
upcall_functor | A pointer to a functor to use instead of the default |
freelist | A pointer to a freelist to use instead of the default |
◆ ACE_Timer_Wheel_T() [2/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::ACE_Timer_Wheel_T |
( |
u_int |
spoke_count, |
|
|
u_int |
resolution, |
|
|
size_t |
prealloc = 0 , |
|
|
FUNCTOR * |
upcall_functor = 0 , |
|
|
FreeList * |
freelist = 0 , |
|
|
TIME_POLICY const & |
time_policy = TIME_POLICY() |
|
) |
| |
Constructor with opportunities to set the wheelsize and resolution.
Constructor that sets up the timing wheel and also may preallocate some nodes on the free list
- Parameters
-
spoke_count | The number of lists in the timer wheel |
resolution | The time resolution in milliseconds used by the hashing function |
prealloc | The number of entries to prealloc in the free_list |
upcall_functor | A pointer to a functor to use instead of the default |
freelist | A pointer to a freelist to use instead of the default |
◆ ~ACE_Timer_Wheel_T()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Destructor.
Destructor just cleans up its memory.
◆ calculate_spoke()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Uses a simple hash to find which spoke to use based on when the timer is due to expire. Hopefully the 64bit int operations avoid any overflow problems.
◆ cancel() [1/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
int ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::cancel |
( |
const TYPE & |
type, |
|
|
int |
skip_close = 1 |
|
) |
| |
|
virtual |
Cancel all timer associated with type. If dont_call_handle_close is 0 then the <functor> will be invoked. Returns number of timers cancelled.
Goes through every list in the wheel and whenever we find one with the correct type value, we remove it and continue. At the end make sure we reset the earliest time value in case the earliest timers were removed.
- Parameters
-
type | The value to search for. |
skip_close | If this non-zero, the cancellation method of the functor will not be called for each cancelled timer. |
- Returns
- Number of timers cancelled
◆ cancel() [2/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
int ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::cancel |
( |
long |
timer_id, |
|
|
const void ** |
act = 0 , |
|
|
int |
skip_close = 1 |
|
) |
| |
|
virtual |
Cancels the single timer that is specified by the timer_id. In this case the timer_id is actually a pointer to the node, so we cast it to the node. This can be dangerous if the timer_id is made up (or deleted twice) so we do a little sanity check. Finally we update the earliest time in case the earliest timer was removed.
- Parameters
-
timer_id | Timer Identifier |
act | Asychronous Completion Token (AKA magic cookie): If this is non-zero, stores the magic cookie of the cancelled timer here. |
skip_close | If this non-zero, the cancellation method of the functor will not be called. |
- Returns
- 1 for sucess and 0 if the timer_id wasn't found (or was found to be invalid)
◆ cancel_i()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Shared subset of the two cancel() methods.
◆ close()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Destroy timer queue. Cancels all timers.
◆ dump()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Dump the state of an object.
Dumps out the size of the wheel, the resolution, and the contents of the wheel.
◆ earliest_time()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Returns the time of the earlier node in the ACE_Timer_Wheel. Must be called on a non-empty queue.
- Returns
- First (earliest) node in the wheel_'s earliest_spoke_ list
◆ expire() [1/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
This is a specialized version of expire that is more suited for the internal data representation.
- Parameters
-
cur_time | The time to expire timers up to. |
- Returns
- Number of timers expired
◆ expire() [2/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Run the <functor> for all timers whose values are <= <ACE_OS::gettimeofday>. Also accounts for <timer_skew>. Returns the number of timers canceled.
◆ find_node()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Searches all spokes for a node matching the specified timer_id Uses the spoke encoded in the timer_id as a starting place.
◆ find_spoke_node()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Searches for a node by timer_id within one spoke.
◆ generate_timer_id()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
long ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::generate_timer_id |
( |
u_int |
spoke | ) |
|
|
private |
Generates a unique timer_id for the given spoke. It should be pretty fast until the point where the counter overflows. At that time you have to do exhaustive searches within the spoke to ensure that a particular timer id is not already in use. Some optimizations are in place so that this hopefully doesn't have to happen often.
◆ get_first()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Reads the earliest node from the queue and returns it.
Returns the earliest node without removing it
- Returns
- The earliest timer node.
◆ get_first_i()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
◆ is_empty()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
bool ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::is_empty |
( |
void |
| ) |
const |
|
virtual |
True if queue is empty, else false.
Check to see if the wheel is empty
- Returns
- True if empty
◆ iter()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Returns a pointer to this <ACE_Timer_Queue_T>'s iterator.
- Returns
- The iterator
◆ open_i()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
void ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::open_i |
( |
size_t |
prealloc, |
|
|
u_int |
spokes, |
|
|
u_int |
res |
|
) |
| |
|
private |
Initialize the queue. Uses the established members for all needed information.
◆ power2bits()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
int ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::power2bits |
( |
int |
n, |
|
|
int |
min_bits, |
|
|
int |
max_bits |
|
) |
| |
|
private |
◆ recalc_earliest()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
There are a few places where we have to figure out which timer will expire next. This method makes the assumption that spokes are always sorted, and that timers are always in the correct spoke determined from their expiration time. The last time is always passed in, even though you can often calculate it as get_first()->get_timer_value().
◆ remove_first()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Removes the earliest node from the queue and returns it.
Removes the earliest node and then find the new <earliest_spoke_>
- Returns
- The earliest timer node.
◆ remove_first_expired()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
◆ reschedule()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Takes an ACE_Timer_Node and inserts it into the correct position in the correct list. Also makes sure to update the earliest time.
- Parameters
-
n | The timer node to reschedule |
◆ reset_interval()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Changes the interval of a timer (and can make it periodic or non periodic by setting it to ACE_Time_Value::zero or not).
Find the timer node by using the id as a pointer. Then use set_interval() on the node to update the interval.
- Parameters
-
timer_id | The timer identifier |
interval | The new interval |
- Returns
- 0 if successful, -1 if no.
◆ schedule_i() [1/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
The shared scheduling functionality between schedule() and reschedule()
◆ schedule_i() [2/2]
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
Schedules a timer.
Creates a ACE_Timer_Node_T based on the input parameters. Then inserts the node into the wheel using reschedule (). Then returns a timer_id.
- Parameters
-
type | The data of the timer node |
act | Asynchronous Completion Token (AKA magic cookie) |
future_time | The time the timer is scheduled for (absolute time) |
interval | If not ACE_Time_Value::zero, then this is a periodic timer and interval is the time period |
- Returns
- Unique identifier (can be used to cancel the timer). -1 on failure.
◆ unlink()
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
◆ ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ earliest_spoke_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Index of the list with the earliest time.
◆ iterator_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Iterator used to expire timers.
◆ res_bits_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Resolution (in microsoconds) of the timing wheel.
◆ spoke_bits_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Number of timer_id bits used for the spoke.
◆ spoke_count_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Size of the timing wheel.
◆ spokes_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
◆ timer_count_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
The total number of timers currently scheduled.
◆ wheel_time_
template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
The total amount of time in one iteration of the wheel. (resolution * spoke_count)
The documentation for this class was generated from the following files: