1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
// $Id$
/* -*- C++ -*- */
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// Timer_Wheel.h
//
// = AUTHOR
// Darrell Brunsch <brunsch@cs.wustl.edu>
//
// ============================================================================
#ifndef ACE_TIMER_WHEEL_T_H
#define ACE_TIMER_WHEEL_T_H
#include "ace/Timer_Queue_T.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
// Forward declaration
template <class TYPE, class FUNCTOR, class ACE_LOCK>
class ACE_Timer_Wheel_T;
template <class TYPE, class FUNCTOR, class ACE_LOCK>
class ACE_Timer_Wheel_Iterator_T : public ACE_Timer_Queue_Iterator_T <TYPE, FUNCTOR, ACE_LOCK>
{
// = TITLE
// Iterates over an <ACE_Timer_Wheel>.
//
// = DESCRIPTION
// This is a generic iterator that can be used to visit every
// node of a timer queue. Be aware that it doesn't transverse
// in the order of timeout values.
public:
ACE_Timer_Wheel_Iterator_T (ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> &);
// Constructor
~ACE_Timer_Wheel_Iterator_T (void);
// Destructor
virtual void first (void);
// Positions the iterator at the earliest node in the Timer Queue
virtual void next (void);
// Positions the iterator at the next node in the Timer Queue
virtual int isdone (void);
// Returns true when there are no more nodes in the sequence
virtual ACE_Timer_Node_T<TYPE> *item (void);
// Returns the node at the current position in the sequence
protected:
ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> &timer_wheel_;
// Pointer to the <ACE_Timer_List> that we are iterating over.
size_t pos_;
// Current position in the timing wheel
ACE_Timer_Node_T<TYPE> *list_item_;
// Pointer to the position in the the <pos_>th list
};
template <class TYPE, class FUNCTOR, class ACE_LOCK>
class ACE_Timer_Wheel_T : public ACE_Timer_Queue_T<TYPE, FUNCTOR, ACE_LOCK>
{
// = TITLE
// Provides a Timing Wheel version of Timer Queue
//
// = DESCRIPTION
// This implementation uses a hash table of ordered doubly-
// linked lists of absolute times. The other enhancements
// to Timer List include using the pointer to the node as the
// timer id (to speed up removing), 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)
public:
typedef ACE_Timer_Wheel_Iterator_T<TYPE, FUNCTOR, ACE_LOCK> WHEEL_ITERATOR;
// Type of iterator
friend class ACE_Timer_Wheel_Iterator_T<TYPE, FUNCTOR, ACE_LOCK>;
// Iterator is a friend
typedef ACE_Timer_Queue_T<TYPE, FUNCTOR, ACE_LOCK> INHERITED;
// Type inherited from
// = Initialization and termination methods
ACE_Timer_Wheel_T (size_t wheelsize,
size_t resolution,
size_t prealloc = 0,
FUNCTOR *upcall_functor = 0,
ACE_Free_List<ACE_Timer_Node_T <TYPE> > *freelist = 0);
// Constructor that takes in <wheelsize> - size of the timing wheel,
// <resolution> - resolution of time values the hashing function uses,
// and <upcall_functor> - a functor that will be used instead of creating
// a default functor. Also, when the freelist is created, <prealloc> nodes
// will be allocated. This can also take in a upcall functor and freelist
// (if 0, then defaults will be created)
ACE_Timer_Wheel_T (FUNCTOR *upcall_functor = 0,
ACE_Free_List<ACE_Timer_Node_T <TYPE> > *freelist = 0);
// Default constructor. <upcall_functor> is the instance of the
// FUNCTOR to be used by the queue. If <upcall_functor> is 0, Timer
// Queue will create a default FUNCTOR. <freelist> the freelist of
// timer nodes. If 0, then a default freelist will be created. The
// defaults will be used for size and resolution and no preallocation
// (ACE_DEFAULT_TIMER_WHEEL_SIZE, ACE_DEFAULT_TIMER_WHEEL_RESOLUTION)
virtual ~ACE_Timer_Wheel_T (void);
// Destructor
virtual int is_empty (void) const;
// True if queue is empty, else false.
virtual const ACE_Time_Value &earliest_time (void) const;
// Returns the time of the earlier node in the <ACE_Timer_Wheel>.
virtual long schedule (const TYPE &type,
const void *act,
const ACE_Time_Value &delay,
const ACE_Time_Value &interval = ACE_Time_Value::zero);
// Schedule <type> that will expire after <delay> amount of time,
// which is specified in absolute time. If it expires then <act> is
// passed in as the value to the <functor>. If <interval> is != to
// <ACE_Time_Value::zero> then it is used to reschedule the <type>
// automatically, using relative time to the current <gettimeofday>.
// This method returns a <timer_id> that uniquely identifies the the
// timer. This <timer_id> can be used to cancel the timer before it
// expires. Returns -1 on failure.
virtual int reset_interval (const long timer_id,
const ACE_Time_Value &interval);
// Resets the interval of the timer represented by <timer_id> to
// <interval>, which is specified in relative time to the current
// <gettimeofday>. If <interval> is equal to
// <ACE_Time_Value::zero>, the timer will become a non-rescheduling
// timer. Returns 0 if successful, -1 if not.
virtual int cancel (const TYPE &type,
int dont_call_handle_close = 1);
// Cancel all timer associated with <type>. If <dont_call> is 0
// then the <functor> will be invoked. Returns number of timers
// cancelled.
virtual int cancel (long timer_id,
const void **act = 0,
int dont_call_handle_close = 1);
// Cancel the single timer that matches the <timer_id> value (which
// was returned from the <schedule> method). If act is non-NULL
// then it will be set to point to the ``magic cookie'' argument
// passed in when the timer was registered. This makes it possible
// to free up the memory and avoid memory leaks. If <dont_call> is
// 0 then the <functor> will be invoked. Returns 1 if cancellation
// succeeded and 0 if the <timer_id> wasn't found.
virtual int expire (void);
// Run the <functor> for all timers whose values are <=
// <ACE_OS::gettimeofday>. Also accounts for <timer_skew>. Returns
// the number of timers canceled.
int expire (const ACE_Time_Value &);
// Run the <functor> for all timers whose values are <= <cur_time>.
// This does not account for <timer_skew>. Returns the number of
// timers canceled.
virtual ACE_Timer_Queue_Iterator_T<TYPE, FUNCTOR, ACE_LOCK> &iter (void);
// Returns a pointer to this <ACE_Timer_Queue_T>'s iterator.
virtual ACE_Timer_Node_T<TYPE> *remove_first (void);
// Removes the earliest node from the queue and returns it
virtual void dump (void) const;
// Dump the state of an object.
virtual ACE_Timer_Node_T<TYPE> *get_first (void);
// Reads the earliest node from the queue and returns it.
private:
virtual void reschedule (ACE_Timer_Node_T<TYPE> *);
// Reschedule an "interval" node
ACE_Timer_Node_T<TYPE> **wheel_;
// Timing Wheel.
size_t wheel_size_;
// Size of the timing wheel.
size_t resolution_;
// Resolution (in microsoconds) of the timing wheel.
size_t earliest_pos_;
// Index of the list with the earliest time
long size_;
// Keeps track of the size of the queue
WHEEL_ITERATOR *iterator_;
// Iterator used to expire timers.
ACE_Timer_Node_T<TYPE> *freelist_;
// Pointer to the freelist of <ACE_Timer_Node_T<TYPE>>.
// = Don't allow these operations for now.
ACE_UNIMPLEMENTED_FUNC (ACE_Timer_Wheel_T (const ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> &))
ACE_UNIMPLEMENTED_FUNC (void operator= (const ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> &))
};
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE) && !defined (ACE_HAS_BROKEN_HPUX_TEMPLATES)
#include "ace/Timer_Wheel_T.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE && !ACE_HAS_BROKEN_HPUX_TEMPLATES */
#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("Timer_Wheel_T.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
#endif /* ACE_TIMER_WHEEL_T_H */
|
