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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>OsclTimerObject class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center>
<hr><h1>OsclTimerObject Class Reference<br>
<small>
[<a class="el" href="group__osclproc.html">OSCL Proc</a>]</small>
</h1><code>#include <<a class="el" href="oscl__scheduler__ao_8h-source.html">oscl_scheduler_ao.h</a>></code>
<p>
<p>Inheritance diagram for OsclTimerObject:
<p><center><img src="classOsclTimerObject.png" usemap="#OsclTimerObject_map" border="0" alt=""></center>
<map name="OsclTimerObject_map">
<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="181,56,352,80">
<area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="362,56,533,80">
<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="181,0,352,24">
<area href="classCallbackTimer.html" alt="CallbackTimer< Alloc >" shape="rect" coords="0,168,171,192">
<area href="classOsclDNSMethod.html" alt="OsclDNSMethod" shape="rect" coords="181,168,352,192">
<area href="classOsclSocketMethod.html" alt="OsclSocketMethod" shape="rect" coords="362,168,533,192">
<area href="classOsclSocketServI.html" alt="OsclSocketServI" shape="rect" coords="543,168,714,192">
<area href="classOsclGetHostByNameMethod.html" alt="OsclGetHostByNameMethod" shape="rect" coords="181,224,352,248">
<area href="classOsclAcceptMethod.html" alt="OsclAcceptMethod" shape="rect" coords="543,224,714,248">
<area href="classOsclBindMethod.html" alt="OsclBindMethod" shape="rect" coords="543,280,714,304">
<area href="classOsclConnectMethod.html" alt="OsclConnectMethod" shape="rect" coords="543,336,714,360">
<area href="classOsclListenMethod.html" alt="OsclListenMethod" shape="rect" coords="543,392,714,416">
<area href="classOsclRecvFromMethod.html" alt="OsclRecvFromMethod" shape="rect" coords="543,448,714,472">
<area href="classOsclRecvMethod.html" alt="OsclRecvMethod" shape="rect" coords="543,504,714,528">
<area href="classOsclSendMethod.html" alt="OsclSendMethod" shape="rect" coords="543,560,714,584">
<area href="classOsclSendToMethod.html" alt="OsclSendToMethod" shape="rect" coords="543,616,714,640">
<area href="classOsclShutdownMethod.html" alt="OsclShutdownMethod" shape="rect" coords="543,672,714,696">
</map>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a0">OsclTimerObject</a> (int32 aPriority, const char name[])</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a1">~OsclTimerObject</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a2">AddToScheduler</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a3">RemoveFromScheduler</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a4">After</a> (int32 aDelayMicrosec)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a5">RunIfNotReady</a> (uint32 aDelayMicrosec=0)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a6">SetBusy</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF bool </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a7">IsBusy</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a8">Cancel</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a9">Priority</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a10">Status</a> () const</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a11">SetStatus</a> (int32)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a> & </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#a12">StatusRef</a> ()</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF void </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#b0">DoCancel</a> ()</td></tr>
<tr><td nowrap align=right valign=top>virtual OSCL_IMPORT_REF int32 </td><td valign=bottom><a class="el" href="classOsclTimerObject.html#b1">RunError</a> (int32 aError)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
User base class for execution objects. OsclTimerObject defines an exec object with a timer.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="OsclTimerObject::OsclTimerObject"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclTimerObject::OsclTimerObject </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int32 </td>
<td class="mdname" nowrap> <em>aPriority</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char </td>
<td class="mdname" nowrap> <em>name</em>[]</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aPriority</em> </td><td>
(input param): scheduling priority </td></tr>
<tr><td valign=top><em>name</em> </td><td>
(input param): optional name for this AO. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="OsclTimerObject::~OsclTimerObject"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF OsclTimerObject::~OsclTimerObject </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destructor. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="OsclTimerObject::AddToScheduler"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::AddToScheduler </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Add this AO to the current thread's scheduler.
<p>
Reimplemented from <a class="el" href="classPVActiveBase.html#a6">PVActiveBase</a>. </td>
</tr>
</table>
<a name="a4" doxytag="OsclTimerObject::After"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::After </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int32 </td>
<td class="mdname1" valign="top" nowrap> <em>aDelayMicrosec</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
'After' sets the request ready, with request status OSCL_REQUEST_STATUS_PENDING, and starts a timer. When the timer expires, the request will complete with status OSCL_REQUEST_ERR_NONE. Must be called from the same thread in which the active object is scheduled. Will leave if the request is already readied, the object is not added to any scheduler, or the calling thread does not match the scheduling thread. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>anInterval:</em> </td><td>
timeout interval in microseconds. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="OsclTimerObject::Cancel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::Cancel </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Cancel any active request. If the request is pending, this will call the DoCancel routine, wait for the request to cancel, then set the request idle. The AO will not run. If the request is not active, it does nothing. Request must be canceled from the same thread in which it is scheduled.
<p>
Reimplemented from <a class="el" href="classPVActiveBase.html#a11">PVActiveBase</a>. </td>
</tr>
</table>
<a name="b0" doxytag="OsclTimerObject::DoCancel"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OsclTimerObject::DoCancel </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Cancel request handler. This gets called by scheduler when the request is cancelled. The default routine will cancel the timer. If any additional action is needed, the derived class may override this. If the derived class does override this, it should explicitly call <a class="el" href="classOsclTimerObject.html#b0">OsclTimerObject::DoCancel</a> in its own DoCancel routine.
<p>
Implements <a class="el" href="classPVActiveBase.html#a5">PVActiveBase</a>. </td>
</tr>
</table>
<a name="a7" doxytag="OsclTimerObject::IsBusy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OsclTimerObject::IsBusy </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return true if this AO is active, false otherwise. </td>
</tr>
</table>
<a name="a9" doxytag="OsclTimerObject::Priority"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclTimerObject::Priority </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return scheduling priority of this exec object. </td>
</tr>
</table>
<a name="a3" doxytag="OsclTimerObject::RemoveFromScheduler"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::RemoveFromScheduler </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Remove this AO from its scheduler. Will leave if the calling thread context does not match the scheduling thread. Cancels any pending request before removing.
<p>
Reimplemented from <a class="el" href="classPVActiveBase.html#a7">PVActiveBase</a>. </td>
</tr>
</table>
<a name="b1" doxytag="OsclTimerObject::RunError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF int32 OsclTimerObject::RunError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int32 </td>
<td class="mdname1" valign="top" nowrap> <em>aError</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Run Leave handler. This gets called by scheduler when the Run routine leaves. The default implementation simply returns the leave code. If the derived class wants to handle errors from Run, it may override this. The ExecError should return OsclErrNone if it handles the error, otherwise it should return the input error code. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aError:</em> </td><td>
the leave code generated by the Run. </td></tr>
</table>
</dl>
<p>
Implements <a class="el" href="classPVActiveBase.html#a3">PVActiveBase</a>. </td>
</tr>
</table>
<a name="a5" doxytag="OsclTimerObject::RunIfNotReady"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::RunIfNotReady </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">uint32 </td>
<td class="mdname1" valign="top" nowrap> <em>aDelayMicrosec</em> = 0 </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Complete the request after a time interval. RunIfNotReady is identical to <a class="el" href="classOsclTimerObject.html#a4">After()</a> except that it first checks the request status, and if it is already readied, it does nothing.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aDelayMicrosec</em> </td><td>
(input param): delay in microseconds. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a6" doxytag="OsclTimerObject::SetBusy"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::SetBusy </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set request ready for this AO. Will leave if the request is already readied, or the exec object is not added to any scheduler, or the calling thread context does not match the scheduler thread. </td>
</tr>
</table>
<a name="a11" doxytag="OsclTimerObject::SetStatus"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::SetStatus </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int32 </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a10" doxytag="OsclTimerObject::Status"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclTimerObject::Status </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Request status access </td>
</tr>
</table>
<a name="a12" doxytag="OsclTimerObject::StatusRef"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a>& OsclTimerObject::StatusRef </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__scheduler__ao_8h-source.html">oscl_scheduler_ao.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>
|
