1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>OsclTimerObject class Reference</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.2.18 --> 7<center> 8<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> 9<hr><h1>OsclTimerObject Class Reference<br> 10<small> 11[<a class="el" href="group__osclproc.html">OSCL Proc</a>]</small> 12</h1><code>#include <<a class="el" href="oscl__scheduler__ao_8h-source.html">oscl_scheduler_ao.h</a>></code> 13<p> 14<p>Inheritance diagram for OsclTimerObject: 15<p><center><img src="classOsclTimerObject.png" usemap="#OsclTimerObject_map" border="0" alt=""></center> 16<map name="OsclTimerObject_map"> 17<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="181,56,352,80"> 18<area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="362,56,533,80"> 19<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="181,0,352,24"> 20<area href="classCallbackTimer.html" alt="CallbackTimer< Alloc >" shape="rect" coords="0,168,171,192"> 21<area href="classOsclDNSMethod.html" alt="OsclDNSMethod" shape="rect" coords="181,168,352,192"> 22<area href="classOsclSocketMethod.html" alt="OsclSocketMethod" shape="rect" coords="362,168,533,192"> 23<area href="classOsclSocketServI.html" alt="OsclSocketServI" shape="rect" coords="543,168,714,192"> 24<area href="classOsclGetHostByNameMethod.html" alt="OsclGetHostByNameMethod" shape="rect" coords="181,224,352,248"> 25<area href="classOsclAcceptMethod.html" alt="OsclAcceptMethod" shape="rect" coords="543,224,714,248"> 26<area href="classOsclBindMethod.html" alt="OsclBindMethod" shape="rect" coords="543,280,714,304"> 27<area href="classOsclConnectMethod.html" alt="OsclConnectMethod" shape="rect" coords="543,336,714,360"> 28<area href="classOsclListenMethod.html" alt="OsclListenMethod" shape="rect" coords="543,392,714,416"> 29<area href="classOsclRecvFromMethod.html" alt="OsclRecvFromMethod" shape="rect" coords="543,448,714,472"> 30<area href="classOsclRecvMethod.html" alt="OsclRecvMethod" shape="rect" coords="543,504,714,528"> 31<area href="classOsclSendMethod.html" alt="OsclSendMethod" shape="rect" coords="543,560,714,584"> 32<area href="classOsclSendToMethod.html" alt="OsclSendToMethod" shape="rect" coords="543,616,714,640"> 33<area href="classOsclShutdownMethod.html" alt="OsclShutdownMethod" shape="rect" coords="543,672,714,696"> 34</map> 35<table border=0 cellpadding=0 cellspacing=0> 36<tr><td></td></tr> 37<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 38<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> 39<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> 40<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> 41<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> 42<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> 43<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> 44<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> 45<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> 46<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> 47<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> 48<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> 49<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> 50<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> 51<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr> 52<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> 53<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> 54</table> 55<hr><a name="_details"></a><h2>Detailed Description</h2> 56User base class for execution objects. OsclTimerObject defines an exec object with a timer. 57<p> 58<hr><h2>Constructor & Destructor Documentation</h2> 59<a name="a0" doxytag="OsclTimerObject::OsclTimerObject"></a><p> 60<table width="100%" cellpadding="2" cellspacing="0" border="0"> 61 <tr> 62 <td class="md"> 63 <table cellpadding="0" cellspacing="0" border="0"> 64 <tr> 65 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF OsclTimerObject::OsclTimerObject </td> 66 <td class="md" valign="top">( </td> 67 <td class="md" nowrap valign="top">int32 </td> 68 <td class="mdname" nowrap> <em>aPriority</em>, </td> 69 </tr> 70 <tr> 71 <td></td> 72 <td></td> 73 <td class="md" nowrap>const char </td> 74 <td class="mdname" nowrap> <em>name</em>[]</td> 75 </tr> 76 <tr> 77 <td></td> 78 <td class="md">) </td> 79 <td class="md" colspan="2"></td> 80 </tr> 81 82 </table> 83 </td> 84 </tr> 85</table> 86<table cellspacing=5 cellpadding=0 border=0> 87 <tr> 88 <td> 89 90 </td> 91 <td> 92 93<p> 94Constructor. <dl compact><dt><b>Parameters: </b></dt><dd> 95<table border=0 cellspacing=2 cellpadding=0> 96<tr><td valign=top><em>aPriority</em> </td><td> 97(input param): scheduling priority </td></tr> 98<tr><td valign=top><em>name</em> </td><td> 99(input param): optional name for this AO. </td></tr> 100</table> 101</dl> </td> 102 </tr> 103</table> 104<a name="a1" doxytag="OsclTimerObject::~OsclTimerObject"></a><p> 105<table width="100%" cellpadding="2" cellspacing="0" border="0"> 106 <tr> 107 <td class="md"> 108 <table cellpadding="0" cellspacing="0" border="0"> 109 <tr> 110 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF OsclTimerObject::~OsclTimerObject </td> 111 <td class="md" valign="top">( </td> 112 <td class="mdname1" valign="top" nowrap> </td> 113 <td class="md" valign="top">) </td> 114 <td class="md" nowrap><code> [virtual]</code></td> 115 </tr> 116 117 </table> 118 </td> 119 </tr> 120</table> 121<table cellspacing=5 cellpadding=0 border=0> 122 <tr> 123 <td> 124 125 </td> 126 <td> 127 128<p> 129Destructor. </td> 130 </tr> 131</table> 132<hr><h2>Member Function Documentation</h2> 133<a name="a2" doxytag="OsclTimerObject::AddToScheduler"></a><p> 134<table width="100%" cellpadding="2" cellspacing="0" border="0"> 135 <tr> 136 <td class="md"> 137 <table cellpadding="0" cellspacing="0" border="0"> 138 <tr> 139 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::AddToScheduler </td> 140 <td class="md" valign="top">( </td> 141 <td class="mdname1" valign="top" nowrap> </td> 142 <td class="md" valign="top">) </td> 143 <td class="md" nowrap></td> 144 </tr> 145 146 </table> 147 </td> 148 </tr> 149</table> 150<table cellspacing=5 cellpadding=0 border=0> 151 <tr> 152 <td> 153 154 </td> 155 <td> 156 157<p> 158Add this AO to the current thread's scheduler. 159<p> 160Reimplemented from <a class="el" href="classPVActiveBase.html#a6">PVActiveBase</a>. </td> 161 </tr> 162</table> 163<a name="a4" doxytag="OsclTimerObject::After"></a><p> 164<table width="100%" cellpadding="2" cellspacing="0" border="0"> 165 <tr> 166 <td class="md"> 167 <table cellpadding="0" cellspacing="0" border="0"> 168 <tr> 169 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::After </td> 170 <td class="md" valign="top">( </td> 171 <td class="md" nowrap valign="top">int32 </td> 172 <td class="mdname1" valign="top" nowrap> <em>aDelayMicrosec</em> </td> 173 <td class="md" valign="top">) </td> 174 <td class="md" nowrap></td> 175 </tr> 176 177 </table> 178 </td> 179 </tr> 180</table> 181<table cellspacing=5 cellpadding=0 border=0> 182 <tr> 183 <td> 184 185 </td> 186 <td> 187 188<p> 189'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> 190<table border=0 cellspacing=2 cellpadding=0> 191<tr><td valign=top><em>anInterval:</em> </td><td> 192timeout interval in microseconds. </td></tr> 193</table> 194</dl> </td> 195 </tr> 196</table> 197<a name="a8" doxytag="OsclTimerObject::Cancel"></a><p> 198<table width="100%" cellpadding="2" cellspacing="0" border="0"> 199 <tr> 200 <td class="md"> 201 <table cellpadding="0" cellspacing="0" border="0"> 202 <tr> 203 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::Cancel </td> 204 <td class="md" valign="top">( </td> 205 <td class="mdname1" valign="top" nowrap> </td> 206 <td class="md" valign="top">) </td> 207 <td class="md" nowrap></td> 208 </tr> 209 210 </table> 211 </td> 212 </tr> 213</table> 214<table cellspacing=5 cellpadding=0 border=0> 215 <tr> 216 <td> 217 218 </td> 219 <td> 220 221<p> 222Cancel 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. 223<p> 224Reimplemented from <a class="el" href="classPVActiveBase.html#a11">PVActiveBase</a>. </td> 225 </tr> 226</table> 227<a name="b0" doxytag="OsclTimerObject::DoCancel"></a><p> 228<table width="100%" cellpadding="2" cellspacing="0" border="0"> 229 <tr> 230 <td class="md"> 231 <table cellpadding="0" cellspacing="0" border="0"> 232 <tr> 233 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF void OsclTimerObject::DoCancel </td> 234 <td class="md" valign="top">( </td> 235 <td class="mdname1" valign="top" nowrap> </td> 236 <td class="md" valign="top">) </td> 237 <td class="md" nowrap><code> [protected, virtual]</code></td> 238 </tr> 239 240 </table> 241 </td> 242 </tr> 243</table> 244<table cellspacing=5 cellpadding=0 border=0> 245 <tr> 246 <td> 247 248 </td> 249 <td> 250 251<p> 252Cancel 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. 253<p> 254Implements <a class="el" href="classPVActiveBase.html#a5">PVActiveBase</a>. </td> 255 </tr> 256</table> 257<a name="a7" doxytag="OsclTimerObject::IsBusy"></a><p> 258<table width="100%" cellpadding="2" cellspacing="0" border="0"> 259 <tr> 260 <td class="md"> 261 <table cellpadding="0" cellspacing="0" border="0"> 262 <tr> 263 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF bool OsclTimerObject::IsBusy </td> 264 <td class="md" valign="top">( </td> 265 <td class="mdname1" valign="top" nowrap> </td> 266 <td class="md" valign="top">) </td> 267 <td class="md" nowrap></td> 268 </tr> 269 270 </table> 271 </td> 272 </tr> 273</table> 274<table cellspacing=5 cellpadding=0 border=0> 275 <tr> 276 <td> 277 278 </td> 279 <td> 280 281<p> 282Return true if this AO is active, false otherwise. </td> 283 </tr> 284</table> 285<a name="a9" doxytag="OsclTimerObject::Priority"></a><p> 286<table width="100%" cellpadding="2" cellspacing="0" border="0"> 287 <tr> 288 <td class="md"> 289 <table cellpadding="0" cellspacing="0" border="0"> 290 <tr> 291 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclTimerObject::Priority </td> 292 <td class="md" valign="top">( </td> 293 <td class="mdname1" valign="top" nowrap> </td> 294 <td class="md" valign="top">) </td> 295 <td class="md" nowrap></td> 296 </tr> 297 298 </table> 299 </td> 300 </tr> 301</table> 302<table cellspacing=5 cellpadding=0 border=0> 303 <tr> 304 <td> 305 306 </td> 307 <td> 308 309<p> 310Return scheduling priority of this exec object. </td> 311 </tr> 312</table> 313<a name="a3" doxytag="OsclTimerObject::RemoveFromScheduler"></a><p> 314<table width="100%" cellpadding="2" cellspacing="0" border="0"> 315 <tr> 316 <td class="md"> 317 <table cellpadding="0" cellspacing="0" border="0"> 318 <tr> 319 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::RemoveFromScheduler </td> 320 <td class="md" valign="top">( </td> 321 <td class="mdname1" valign="top" nowrap> </td> 322 <td class="md" valign="top">) </td> 323 <td class="md" nowrap></td> 324 </tr> 325 326 </table> 327 </td> 328 </tr> 329</table> 330<table cellspacing=5 cellpadding=0 border=0> 331 <tr> 332 <td> 333 334 </td> 335 <td> 336 337<p> 338Remove this AO from its scheduler. Will leave if the calling thread context does not match the scheduling thread. Cancels any pending request before removing. 339<p> 340Reimplemented from <a class="el" href="classPVActiveBase.html#a7">PVActiveBase</a>. </td> 341 </tr> 342</table> 343<a name="b1" doxytag="OsclTimerObject::RunError"></a><p> 344<table width="100%" cellpadding="2" cellspacing="0" border="0"> 345 <tr> 346 <td class="md"> 347 <table cellpadding="0" cellspacing="0" border="0"> 348 <tr> 349 <td class="md" nowrap valign="top"> virtual OSCL_IMPORT_REF int32 OsclTimerObject::RunError </td> 350 <td class="md" valign="top">( </td> 351 <td class="md" nowrap valign="top">int32 </td> 352 <td class="mdname1" valign="top" nowrap> <em>aError</em> </td> 353 <td class="md" valign="top">) </td> 354 <td class="md" nowrap><code> [protected, virtual]</code></td> 355 </tr> 356 357 </table> 358 </td> 359 </tr> 360</table> 361<table cellspacing=5 cellpadding=0 border=0> 362 <tr> 363 <td> 364 365 </td> 366 <td> 367 368<p> 369Run 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> 370<table border=0 cellspacing=2 cellpadding=0> 371<tr><td valign=top><em>aError:</em> </td><td> 372the leave code generated by the Run. </td></tr> 373</table> 374</dl> 375<p> 376Implements <a class="el" href="classPVActiveBase.html#a3">PVActiveBase</a>. </td> 377 </tr> 378</table> 379<a name="a5" doxytag="OsclTimerObject::RunIfNotReady"></a><p> 380<table width="100%" cellpadding="2" cellspacing="0" border="0"> 381 <tr> 382 <td class="md"> 383 <table cellpadding="0" cellspacing="0" border="0"> 384 <tr> 385 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::RunIfNotReady </td> 386 <td class="md" valign="top">( </td> 387 <td class="md" nowrap valign="top">uint32 </td> 388 <td class="mdname1" valign="top" nowrap> <em>aDelayMicrosec</em> = 0 </td> 389 <td class="md" valign="top">) </td> 390 <td class="md" nowrap></td> 391 </tr> 392 393 </table> 394 </td> 395 </tr> 396</table> 397<table cellspacing=5 cellpadding=0 border=0> 398 <tr> 399 <td> 400 401 </td> 402 <td> 403 404<p> 405Complete 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> 406<table border=0 cellspacing=2 cellpadding=0> 407<tr><td valign=top><em>aDelayMicrosec</em> </td><td> 408(input param): delay in microseconds. </td></tr> 409</table> 410</dl> </td> 411 </tr> 412</table> 413<a name="a6" doxytag="OsclTimerObject::SetBusy"></a><p> 414<table width="100%" cellpadding="2" cellspacing="0" border="0"> 415 <tr> 416 <td class="md"> 417 <table cellpadding="0" cellspacing="0" border="0"> 418 <tr> 419 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::SetBusy </td> 420 <td class="md" valign="top">( </td> 421 <td class="mdname1" valign="top" nowrap> </td> 422 <td class="md" valign="top">) </td> 423 <td class="md" nowrap></td> 424 </tr> 425 426 </table> 427 </td> 428 </tr> 429</table> 430<table cellspacing=5 cellpadding=0 border=0> 431 <tr> 432 <td> 433 434 </td> 435 <td> 436 437<p> 438Set 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> 439 </tr> 440</table> 441<a name="a11" doxytag="OsclTimerObject::SetStatus"></a><p> 442<table width="100%" cellpadding="2" cellspacing="0" border="0"> 443 <tr> 444 <td class="md"> 445 <table cellpadding="0" cellspacing="0" border="0"> 446 <tr> 447 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void OsclTimerObject::SetStatus </td> 448 <td class="md" valign="top">( </td> 449 <td class="md" nowrap valign="top">int32 </td> 450 <td class="mdname1" valign="top" nowrap> </td> 451 <td class="md" valign="top">) </td> 452 <td class="md" nowrap></td> 453 </tr> 454 455 </table> 456 </td> 457 </tr> 458</table> 459<table cellspacing=5 cellpadding=0 border=0> 460 <tr> 461 <td> 462 463 </td> 464 <td> 465 466<p> 467 </td> 468 </tr> 469</table> 470<a name="a10" doxytag="OsclTimerObject::Status"></a><p> 471<table width="100%" cellpadding="2" cellspacing="0" border="0"> 472 <tr> 473 <td class="md"> 474 <table cellpadding="0" cellspacing="0" border="0"> 475 <tr> 476 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF int32 OsclTimerObject::Status </td> 477 <td class="md" valign="top">( </td> 478 <td class="mdname1" valign="top" nowrap> </td> 479 <td class="md" valign="top">) </td> 480 <td class="md" nowrap></td> 481 </tr> 482 483 </table> 484 </td> 485 </tr> 486</table> 487<table cellspacing=5 cellpadding=0 border=0> 488 <tr> 489 <td> 490 491 </td> 492 <td> 493 494<p> 495Request status access </td> 496 </tr> 497</table> 498<a name="a12" doxytag="OsclTimerObject::StatusRef"></a><p> 499<table width="100%" cellpadding="2" cellspacing="0" border="0"> 500 <tr> 501 <td class="md"> 502 <table cellpadding="0" cellspacing="0" border="0"> 503 <tr> 504 <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classOsclAOStatus.html">OsclAOStatus</a>& OsclTimerObject::StatusRef </td> 505 <td class="md" valign="top">( </td> 506 <td class="mdname1" valign="top" nowrap> </td> 507 <td class="md" valign="top">) </td> 508 <td class="md" nowrap></td> 509 </tr> 510 511 </table> 512 </td> 513 </tr> 514</table> 515<table cellspacing=5 cellpadding=0 border=0> 516 <tr> 517 <td> 518 519 </td> 520 <td> 521 522<p> 523 </td> 524 </tr> 525</table> 526<hr>The documentation for this class was generated from the following file:<ul> 527<li><a class="el" href="oscl__scheduler__ao_8h-source.html">oscl_scheduler_ao.h</a></ul> 528<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 529<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 530</small></address> 531</body> 532</html> 533
