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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: OsclActiveObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>OsclActiveObject Class Reference<br/>
<small>
[<a class="el" href="group__osclproc.html">OSCL Proc</a>]</small>
</h1><!-- doxytag: class="OsclActiveObject" --><!-- doxytag: inherits="HeapBase,PVActiveBase" -->
<p><code>#include <<a class="el" href="oscl__scheduler__ao_8h_source.html">oscl_scheduler_ao.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for OsclActiveObject:</div>
<div class="dynsection">
<div class="center">
<img src="classOsclActiveObject.png" usemap="#OsclActiveObject_map" alt=""/>
<map id="OsclActiveObject_map" name="OsclActiveObject_map">
<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="183,56,356,80"/>
<area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="366,56,539,80"/>
<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="183,0,356,24"/>
<area href="classOsclAsyncFile.html" alt="OsclAsyncFile" shape="rect" coords="0,168,173,192"/>
<area href="classOsclDNSRequestAO.html" alt="OsclDNSRequestAO" shape="rect" coords="183,168,356,192"/>
<area href="classOsclSocketRequestAO.html" alt="OsclSocketRequestAO" shape="rect" coords="366,168,539,192"/>
<area href="classPVSchedulerStopper.html" alt="PVSchedulerStopper" shape="rect" coords="549,168,722,192"/>
<area href="classOsclGetHostByNameRequest.html" alt="OsclGetHostByNameRequest" shape="rect" coords="183,224,356,248"/>
<area href="classOsclAcceptRequest.html" alt="OsclAcceptRequest" shape="rect" coords="549,224,722,248"/>
<area href="classOsclBindRequest.html" alt="OsclBindRequest" shape="rect" coords="549,280,722,304"/>
<area href="classOsclConnectRequest.html" alt="OsclConnectRequest" shape="rect" coords="549,336,722,360"/>
<area href="classOsclListenRequest.html" alt="OsclListenRequest" shape="rect" coords="549,392,722,416"/>
<area href="classOsclRecvFromRequest.html" alt="OsclRecvFromRequest" shape="rect" coords="549,448,722,472"/>
<area href="classOsclRecvRequest.html" alt="OsclRecvRequest" shape="rect" coords="549,504,722,528"/>
<area href="classOsclSendRequest.html" alt="OsclSendRequest" shape="rect" coords="549,560,722,584"/>
<area href="classOsclSendToRequest.html" alt="OsclSendToRequest" shape="rect" coords="549,616,722,640"/>
<area href="classOsclShutdownRequest.html" alt="OsclShutdownRequest" shape="rect" coords="549,672,722,696"/>
</map>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0">OsclActivePriority</a> { <br/>
<a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0a0a7259f91e9d1b8613640e59b75b88f4">EPriorityIdle</a> = -100,
<a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0aeb8db4e765f38e0b9fcc5a6fac78a891">EPriorityLow</a> = -20,
<a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0ac3fd95a1c0e4db2a29e896205ec826f4">EPriorityNominal</a> = 0,
<a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0a901bd4958d78dff820fd013f9e08487a">EPriorityHigh</a> = 10,
<br/>
<a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0a20638c1eb19646e8e27ad2ec0a7db99f">EPriorityHighest</a> = 20
<br/>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a6fae0e53cb8a252d8583784d8aeb8b06">OsclActiveObject</a> (int32 aPriority, const char name[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a7410df79308f4e936d2e135896396f27">~OsclActiveObject</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#ab877137a177535553e65671608c2cf04">SetBusy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#ab53e9c6dae5633f06c611b619d54b17b">IsBusy</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a3c65c28444ac767dbba4df94754b30eb">PendForExec</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#ac4785fb73cb83e4f3558b465f8f98e88">PendComplete</a> (int32 aStatus)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a7955d30157ad4456bb7bc7a90cfa0d44">AddToScheduler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a1baef84c675b654fbe734c0654a37085">RemoveFromScheduler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#aba4656a1c819d4d5002e1bc29720624a">RunIfNotReady</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a54dd85d9ed6c7d73472516cf992038b1">Cancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#abbfcc95f1bd493467e5922c25dfad4c9">Priority</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a87df4dd08795ac6a328253ba4b06a0c4">Status</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a807d1ddc89b24e65f8b1c58564738776">SetStatus</a> (int32)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#aea0329e4e1afff002533faaad20e44a0">StatusRef</a> ()</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#aaa5c4ed46c4a5477f07281cd7772d9de">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OSCL_IMPORT_REF int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclActiveObject.html#a7a4ae4f6da1e4558615a5ce9049b2cd8">RunError</a> (int32 aError)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>User base class for execution objects. <a class="el" href="classOsclActiveObject.html">OsclActiveObject</a> defines an execution object without any timer. This AO can be used across threads, i.e. the request can be activated in one thread and completed in another. </p>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0"></a><!-- doxytag: member="OsclActiveObject::OsclActivePriority" ref="a3c6b06249a7434b0e513491f6498ebb0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classOsclActiveObject.html#a3c6b06249a7434b0e513491f6498ebb0">OsclActiveObject::OsclActivePriority</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scheduling priorities. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0a0a7259f91e9d1b8613640e59b75b88f4"></a><!-- doxytag: member="EPriorityIdle" ref="a3c6b06249a7434b0e513491f6498ebb0a0a7259f91e9d1b8613640e59b75b88f4" args="" -->EPriorityIdle</em> </td><td>
<p>A low priority, useful for execution objects representing background processing. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0aeb8db4e765f38e0b9fcc5a6fac78a891"></a><!-- doxytag: member="EPriorityLow" ref="a3c6b06249a7434b0e513491f6498ebb0aeb8db4e765f38e0b9fcc5a6fac78a891" args="" -->EPriorityLow</em> </td><td>
<p>A priority higher than EPriorityIdle but lower than EPriorityNominal. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0ac3fd95a1c0e4db2a29e896205ec826f4"></a><!-- doxytag: member="EPriorityNominal" ref="a3c6b06249a7434b0e513491f6498ebb0ac3fd95a1c0e4db2a29e896205ec826f4" args="" -->EPriorityNominal</em> </td><td>
<p>Most exec objects will have this priority. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0a901bd4958d78dff820fd013f9e08487a"></a><!-- doxytag: member="EPriorityHigh" ref="a3c6b06249a7434b0e513491f6498ebb0a901bd4958d78dff820fd013f9e08487a" args="" -->EPriorityHigh</em> </td><td>
<p>A priority higher than EPriorityNominal; useful for execution objects handling user input. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3c6b06249a7434b0e513491f6498ebb0a20638c1eb19646e8e27ad2ec0a7db99f"></a><!-- doxytag: member="EPriorityHighest" ref="a3c6b06249a7434b0e513491f6498ebb0a20638c1eb19646e8e27ad2ec0a7db99f" args="" -->EPriorityHighest</em> </td><td>
<p>A priority higher than EPriorityHighest. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6fae0e53cb8a252d8583784d8aeb8b06"></a><!-- doxytag: member="OsclActiveObject::OsclActiveObject" ref="a6fae0e53cb8a252d8583784d8aeb8b06" args="(int32 aPriority, const char name[])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF OsclActiveObject::OsclActiveObject </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>aPriority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char </td>
<td class="paramname"> <em>name</em>[]</td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPriority</em> </td><td>(input param): scheduling priority </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>(inpup param): optional name for this AO. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7410df79308f4e936d2e135896396f27"></a><!-- doxytag: member="OsclActiveObject::~OsclActiveObject" ref="a7410df79308f4e936d2e135896396f27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF OsclActiveObject::~OsclActiveObject </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7955d30157ad4456bb7bc7a90cfa0d44"></a><!-- doxytag: member="OsclActiveObject::AddToScheduler" ref="a7955d30157ad4456bb7bc7a90cfa0d44" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::AddToScheduler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add this exec object to the current thread's scheduler. </p>
<p>Reimplemented from <a class="el" href="classPVActiveBase.html#a3063bac924180230ad80c9c984430e76">PVActiveBase</a>.</p>
</div>
</div>
<a class="anchor" id="a54dd85d9ed6c7d73472516cf992038b1"></a><!-- doxytag: member="OsclActiveObject::Cancel" ref="a54dd85d9ed6c7d73472516cf992038b1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::Cancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel any pending request. If the request is readied, 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 readied, it does nothing. Request must be canceled from the same thread in which it is scheduled. </p>
<p>Reimplemented from <a class="el" href="classPVActiveBase.html#aa56b9569d49d6cda024db7601eeb0256">PVActiveBase</a>.</p>
<p>Referenced by <a class="el" href="oscl__socket__method_8h_source.html#l00107">OsclSocketRequestAO::Abort()</a>, and <a class="el" href="oscl__dns__method_8h_source.html#l00086">OsclDNSRequestAO::Abort()</a>.</p>
</div>
</div>
<a class="anchor" id="aaa5c4ed46c4a5477f07281cd7772d9de"></a><!-- doxytag: member="OsclActiveObject::DoCancel" ref="aaa5c4ed46c4a5477f07281cd7772d9de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF void OsclActiveObject::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel request handler. This gets called by scheduler when the request is cancelled. The default routine will complete the request. If any additional action is needed, the derived class may override this. If the derived class does override DoCancel, it must complete the request. </p>
<p>Implements <a class="el" href="classPVActiveBase.html#aa12bb70392debc8950613a145c1dbe74">PVActiveBase</a>.</p>
<p>Reimplemented in <a class="el" href="classOsclDNSRequestAO.html#a47553d505ef919cb8265a6b3ff34ec24">OsclDNSRequestAO</a>, and <a class="el" href="classOsclSocketRequestAO.html#ad5f28ca151d6bb17887452a331eb6144">OsclSocketRequestAO</a>.</p>
</div>
</div>
<a class="anchor" id="ab53e9c6dae5633f06c611b619d54b17b"></a><!-- doxytag: member="OsclActiveObject::IsBusy" ref="ab53e9c6dae5633f06c611b619d54b17b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF bool OsclActiveObject::IsBusy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return true if this AO is pending, false otherwise. </p>
</div>
</div>
<a class="anchor" id="ac4785fb73cb83e4f3558b465f8f98e88"></a><!-- doxytag: member="OsclActiveObject::PendComplete" ref="ac4785fb73cb83e4f3558b465f8f98e88" args="(int32 aStatus)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::PendComplete </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>aStatus</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Complete the active request for the AO. This API is thread-safe. If the request is not pending, this call will leave. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aStatus,:</em> </td><td>request completion status. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3c65c28444ac767dbba4df94754b30eb"></a><!-- doxytag: member="OsclActiveObject::PendForExec" ref="a3c65c28444ac767dbba4df94754b30eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::PendForExec </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set request active for this AO and set the status to pending. PendForExec is identical to SetActive, but it additionally sets the request status to OSCL_REQUEST_PENDING. </p>
</div>
</div>
<a class="anchor" id="abbfcc95f1bd493467e5922c25dfad4c9"></a><!-- doxytag: member="OsclActiveObject::Priority" ref="abbfcc95f1bd493467e5922c25dfad4c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF int32 OsclActiveObject::Priority </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return scheduling priority of this exec object. </p>
</div>
</div>
<a class="anchor" id="a1baef84c675b654fbe734c0654a37085"></a><!-- doxytag: member="OsclActiveObject::RemoveFromScheduler" ref="a1baef84c675b654fbe734c0654a37085" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::RemoveFromScheduler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove this AO from its scheduler. Will leave if the calling thread context does not match the scheduling thread. Cancels any readied request before removing. </p>
<p>Reimplemented from <a class="el" href="classPVActiveBase.html#a5988c0ff01573788fbbb71851e9a2862">PVActiveBase</a>.</p>
<p>Referenced by <a class="el" href="oscl__dns__method_8h_source.html#l00086">OsclDNSRequestAO::Abort()</a>.</p>
</div>
</div>
<a class="anchor" id="a7a4ae4f6da1e4558615a5ce9049b2cd8"></a><!-- doxytag: member="OsclActiveObject::RunError" ref="a7a4ae4f6da1e4558615a5ce9049b2cd8" args="(int32 aError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OSCL_IMPORT_REF int32 OsclActiveObject::RunError </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Run Error 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 RunError should return OsclErrNone if it handles the error, otherwise it should return the input error code. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aError,:</em> </td><td>the leave code generated by the Run. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classPVActiveBase.html#a3031119f405227e715b4441801b1fab8">PVActiveBase</a>.</p>
</div>
</div>
<a class="anchor" id="aba4656a1c819d4d5002e1bc29720624a"></a><!-- doxytag: member="OsclActiveObject::RunIfNotReady" ref="aba4656a1c819d4d5002e1bc29720624a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::RunIfNotReady </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Complete this AO's request immediately. If the AO is already active, this will do nothing. Will leave if the AO is not added to any scheduler, or if the calling thread context does not match the scheduling thread. </p>
</div>
</div>
<a class="anchor" id="ab877137a177535553e65671608c2cf04"></a><!-- doxytag: member="OsclActiveObject::SetBusy" ref="ab877137a177535553e65671608c2cf04" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::SetBusy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set object ready for this AO, additionally sets the request status to OSCL_REQUEST_PENDING. Will leave if the request is already readied, or the execution object is not added to any scheduler, or the calling thread context does not match the scheduler thread. </p>
</div>
</div>
<a class="anchor" id="a807d1ddc89b24e65f8b1c58564738776"></a><!-- doxytag: member="OsclActiveObject::SetStatus" ref="a807d1ddc89b24e65f8b1c58564738776" args="(int32)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF void OsclActiveObject::SetStatus </td>
<td>(</td>
<td class="paramtype">int32 </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a87df4dd08795ac6a328253ba4b06a0c4"></a><!-- doxytag: member="OsclActiveObject::Status" ref="a87df4dd08795ac6a328253ba4b06a0c4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF int32 OsclActiveObject::Status </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request status access </p>
</div>
</div>
<a class="anchor" id="aea0329e4e1afff002533faaad20e44a0"></a><!-- doxytag: member="OsclActiveObject::StatusRef" ref="aea0329e4e1afff002533faaad20e44a0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OSCL_IMPORT_REF <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a>& OsclActiveObject::StatusRef </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.002.1.1 </small>
</small></address>
</body>
</html>
|
