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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
.TH ACE_Timer_Node_T 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Timer_Node_T \- Maintains the state associated with a Timer entry.
.SH SYNOPSIS
.br
.PP
\fC#include <Timer_Queue_T.h>\fR
.PP
.SS Public Types
.in +1c
.ti -1c
.RI "typedef \fBACE_Timer_Node_Dispatch_Info_T\fR<TYPE> \fBDISPATCH_INFO\fR"
.br
.RI "\fIUseful typedef ..\fR"
.in -1c
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Timer_Node_T\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.ti -1c
.RI "\fB~ACE_Timer_Node_T\fR (void)"
.br
.RI "\fIDtor.\fR"
.ti -1c
.RI "void \fBset\fR (const TYPE &type, const void *a, const \fBACE_Time_Value\fR &t, const \fBACE_Time_Value\fR &i, ACE_Timer_Node_T<TYPE> *n, long timer_id)"
.br
.RI "\fIsingly linked list.\fR"
.ti -1c
.RI "void \fBset\fR (const TYPE &type, const void *a, const \fBACE_Time_Value\fR &t, const \fBACE_Time_Value\fR &i, ACE_Timer_Node_T<TYPE> *p, ACE_Timer_Node_T<TYPE> *n, long timer_id)"
.br
.RI "\fIdoubly linked list version.\fR"
.ti -1c
.RI "TYPE& \fBget_type\fR (void)"
.br
.RI "\fIGet the type.\fR"
.ti -1c
.RI "void \fBset_type\fR (TYPE &type)"
.br
.RI "\fISet the type.\fR"
.ti -1c
.RI "const void* \fBget_act\fR (void)"
.br
.RI "\fIGet the asynchronous completion token.\fR"
.ti -1c
.RI "void \fBset_act\fR (void *act)"
.br
.RI "\fIset the asynchronous completion token.\fR"
.ti -1c
.RI "const \fBACE_Time_Value\fR& \fBget_timer_value\fR (void) const"
.br
.RI "\fIget the timer value.\fR"
.ti -1c
.RI "void \fBset_timer_value\fR (const \fBACE_Time_Value\fR &timer_value)"
.br
.RI "\fIset the timer value.\fR"
.ti -1c
.RI "const \fBACE_Time_Value\fR& \fBget_interval\fR (void) const"
.br
.RI "\fIget the timer interval.\fR"
.ti -1c
.RI "void \fBset_interval\fR (const \fBACE_Time_Value\fR &interval)"
.br
.RI "\fISet the timer interval.\fR"
.ti -1c
.RI "ACE_Timer_Node_T<TYPE>* \fBget_prev\fR (void)"
.br
.RI "\fIget the previous pointer.\fR"
.ti -1c
.RI "void \fBset_prev\fR (ACE_Timer_Node_T<TYPE> *prev)"
.br
.RI "\fIset the previous pointer.\fR"
.ti -1c
.RI "ACE_Timer_Node_T<TYPE>* \fBget_next\fR (void)"
.br
.RI "\fIget the next pointer.\fR"
.ti -1c
.RI "void \fBset_next\fR (ACE_Timer_Node_T<TYPE> *next)"
.br
.RI "\fIset the next pointer.\fR"
.ti -1c
.RI "long \fBget_timer_id\fR (void) const"
.br
.RI "\fIget the timer_id.\fR"
.ti -1c
.RI "void \fBset_timer_id\fR (long timer_id)"
.br
.RI "\fIset the timer_id.\fR"
.ti -1c
.RI "void \fBget_dispatch_info\fR (\fBACE_Timer_Node_Dispatch_Info_T\fR <TYPE> &info)"
.br
.RI "\fIGet the dispatch info. The dispatch information is got through <info>. This form helps us in preventing allocation and deleting data along the criticl path. TODO: We may want to have a copying version too, so that our interface will be complete..\fR"
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an TYPE.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "TYPE \fBtype_\fR"
.br
.RI "\fIType of object stored in the Queue.\fR"
.ti -1c
.RI "const void* \fBact_\fR"
.br
.RI "\fIAsynchronous completion token associated with the timer.\fR"
.ti -1c
.RI "\fBACE_Time_Value\fR \fBtimer_value_\fR"
.br
.RI "\fITime until the timer expires.\fR"
.ti -1c
.RI "\fBACE_Time_Value\fR \fBinterval_\fR"
.br
.RI "\fIIf this is a periodic timer this holds the time until the next timeout.\fR"
.ti -1c
.RI "ACE_Timer_Node_T<TYPE>* \fBprev_\fR"
.br
.RI "\fIPointer to previous timer.\fR"
.ti -1c
.RI "ACE_Timer_Node_T<TYPE>* \fBnext_\fR"
.br
.RI "\fIPointer to next timer.\fR"
.ti -1c
.RI "long \fBtimer_id_\fR"
.br
.RI "\fIId of this timer (used to cancel timers before they expire).\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
.SS template<class TYPE> template class ACE_Timer_Node_T
Maintains the state associated with a Timer entry.
.PP
.SH MEMBER TYPEDEF DOCUMENTATION
.PP
.SS template<classTYPE> typedef \fBACE_Timer_Node_Dispatch_Info_T\fR<TYPE> ACE_Timer_Node_T<TYPE>::DISPATCH_INFO
.PP
Useful typedef ..
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS template<classTYPE> ACE_Timer_Node_T<TYPE>::ACE_Timer_Node_T<TYPE> (void)
.PP
Default constructor.
.PP
.SS template<classTYPE> ACE_Timer_Node_T<TYPE>::~ACE_Timer_Node_T<TYPE> (void)
.PP
Dtor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::dump (void) const
.PP
Dump the state of an TYPE.
.PP
.SS template<classTYPE> const void * ACE_Timer_Node_T<TYPE>::get_act (void)
.PP
Get the asynchronous completion token.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::get_dispatch_info (\fBACE_Timer_Node_Dispatch_Info_T\fR< TYPE >& info)
.PP
Get the dispatch info. The dispatch information is got through <info>. This form helps us in preventing allocation and deleting data along the criticl path. TODO: We may want to have a copying version too, so that our interface will be complete..
.PP
@
.SS template<classTYPE> const \fBACE_Time_Value\fR & ACE_Timer_Node_T<TYPE>::get_interval (void) const
.PP
get the timer interval.
.PP
.SS template<classTYPE> ACE_Timer_Node_T< TYPE >* ACE_Timer_Node_T<TYPE>::get_next (void)
.PP
get the next pointer.
.PP
.SS template<classTYPE> ACE_Timer_Node_T< TYPE >* ACE_Timer_Node_T<TYPE>::get_prev (void)
.PP
get the previous pointer.
.PP
.SS template<classTYPE> long ACE_Timer_Node_T<TYPE>::get_timer_id (void) const
.PP
get the timer_id.
.PP
.SS template<classTYPE> const \fBACE_Time_Value\fR & ACE_Timer_Node_T<TYPE>::get_timer_value (void) const
.PP
get the timer value.
.PP
.SS template<classTYPE> TYPE & ACE_Timer_Node_T<TYPE>::get_type (void)
.PP
Get the type.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set (const TYPE & type, const void * a, const \fBACE_Time_Value\fR & t, const \fBACE_Time_Value\fR & i, ACE_Timer_Node_T< TYPE >* p, ACE_Timer_Node_T< TYPE >* n, long timer_id)
.PP
doubly linked list version.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set (const TYPE & type, const void * a, const \fBACE_Time_Value\fR & t, const \fBACE_Time_Value\fR & i, ACE_Timer_Node_T< TYPE >* n, long timer_id)
.PP
singly linked list.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_act (void * act)
.PP
set the asynchronous completion token.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_interval (const \fBACE_Time_Value\fR & interval)
.PP
Set the timer interval.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_next (ACE_Timer_Node_T< TYPE >* next)
.PP
set the next pointer.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_prev (ACE_Timer_Node_T< TYPE >* prev)
.PP
set the previous pointer.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_timer_id (long timer_id)
.PP
set the timer_id.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_timer_value (const \fBACE_Time_Value\fR & timer_value)
.PP
set the timer value.
.PP
.SS template<classTYPE> void ACE_Timer_Node_T<TYPE>::set_type (TYPE & type)
.PP
Set the type.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS template<classTYPE> const void * ACE_Timer_Node_T<TYPE>::act_\fC [private]\fR
.PP
Asynchronous completion token associated with the timer.
.PP
.SS template<classTYPE> \fBACE_Time_Value\fR ACE_Timer_Node_T<TYPE>::interval_\fC [private]\fR
.PP
If this is a periodic timer this holds the time until the next timeout.
.PP
.SS template<classTYPE> ACE_Timer_Node_T< TYPE >* ACE_Timer_Node_T<TYPE>::next_\fC [private]\fR
.PP
Pointer to next timer.
.PP
.SS template<classTYPE> ACE_Timer_Node_T< TYPE >* ACE_Timer_Node_T<TYPE>::prev_\fC [private]\fR
.PP
Pointer to previous timer.
.PP
.SS template<classTYPE> long ACE_Timer_Node_T<TYPE>::timer_id_\fC [private]\fR
.PP
Id of this timer (used to cancel timers before they expire).
.PP
.SS template<classTYPE> \fBACE_Time_Value\fR ACE_Timer_Node_T<TYPE>::timer_value_\fC [private]\fR
.PP
Time until the timer expires.
.PP
.SS template<classTYPE> TYPE ACE_Timer_Node_T<TYPE>::type_\fC [private]\fR
.PP
Type of object stored in the Queue.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
