Home | History | Annotate | Download | only in oscl_html
      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> TemplateCallbackTimer&lt; Alloc &gt; 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> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
      9 <hr><h1>CallbackTimer&lt; Alloc &gt; Class Template Reference</h1><code>#include &lt;<a class="el" href="oscl__timer_8h-source.html">oscl_timer.h</a>&gt;</code>
     10 <p>
     11 <p>Inheritance diagram for CallbackTimer&lt; Alloc &gt;:
     12 <p><center><img src="classCallbackTimer.png" usemap="#CallbackTimer< Alloc >_map" border="0" alt=""></center>
     13 <map name="CallbackTimer< Alloc >_map">
     14 <area href="classOsclTimerObject.html" alt="OsclTimerObject" shape="rect" coords="77,112,222,136">
     15 <area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,145,80">
     16 <area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="155,56,300,80">
     17 <area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,145,24">
     18 </map>
     19 <table border=0 cellpadding=0 cellspacing=0>
     20 <tr><td></td></tr>
     21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
     22 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classCallbackTimer.html#a0">CallbackTimer</a> (<a class="el" href="classCallbackTimerObserver.html">CallbackTimerObserver</a> &amp;aContainer, const char *name, int32 aPriority=OsclActiveObject::EPriorityNominal)</td></tr>
     23 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classCallbackTimer.html#a1">~CallbackTimer</a> ()</td></tr>
     24 <tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classCallbackTimer.html#a2">Run</a> ()</td></tr>
     25 </table>
     26 <h3>template&lt;class Alloc&gt;<br>
     27  class CallbackTimer&lt; Alloc &gt;</h3>
     28 
     29 <hr><h2>Constructor &amp; Destructor Documentation</h2>
     30 <a name="a0" doxytag="CallbackTimer::CallbackTimer"></a><p>
     31 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     32   <tr>
     33     <td class="md">
     34       <table cellpadding="0" cellspacing="0" border="0">
     35         <tr>
     36           <td class="md" colspan="4">
     37 template&lt;class Alloc&gt; </td>
     38         </tr>
     39         <tr>
     40           <td class="md" nowrap valign="top"> CallbackTimer&lt; Alloc &gt;::CallbackTimer </td>
     41           <td class="md" valign="top">(&nbsp;</td>
     42           <td class="md" nowrap valign="top"><a class="el" href="classCallbackTimerObserver.html">CallbackTimerObserver</a> &amp;&nbsp;</td>
     43           <td class="mdname" nowrap>&nbsp; <em>aContainer</em>, </td>
     44         </tr>
     45         <tr>
     46           <td></td>
     47           <td></td>
     48           <td class="md" nowrap>const char *&nbsp;</td>
     49           <td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
     50         </tr>
     51         <tr>
     52           <td></td>
     53           <td></td>
     54           <td class="md" nowrap>int32&nbsp;</td>
     55           <td class="mdname" nowrap>&nbsp; <em>aPriority</em> = OsclActiveObject::EPriorityNominal</td>
     56         </tr>
     57         <tr>
     58           <td></td>
     59           <td class="md">)&nbsp;</td>
     60           <td class="md" colspan="2"><code> [inline]</code></td>
     61         </tr>
     62 
     63       </table>
     64     </td>
     65   </tr>
     66 </table>
     67 <table cellspacing=5 cellpadding=0 border=0>
     68   <tr>
     69     <td>
     70       &nbsp;
     71     </td>
     72     <td>
     73 
     74 <p>
     75     </td>
     76   </tr>
     77 </table>
     78 <a name="a1" doxytag="CallbackTimer::~CallbackTimer"></a><p>
     79 <table width="100%" cellpadding="2" cellspacing="0" border="0">
     80   <tr>
     81     <td class="md">
     82       <table cellpadding="0" cellspacing="0" border="0">
     83         <tr>
     84           <td class="md" colspan="4">
     85 template&lt;class Alloc&gt; </td>
     86         </tr>
     87         <tr>
     88           <td class="md" nowrap valign="top"> CallbackTimer&lt; Alloc &gt;::~CallbackTimer </td>
     89           <td class="md" valign="top">(&nbsp;</td>
     90           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
     91           <td class="md" valign="top">)&nbsp;</td>
     92           <td class="md" nowrap><code> [inline]</code></td>
     93         </tr>
     94 
     95       </table>
     96     </td>
     97   </tr>
     98 </table>
     99 <table cellspacing=5 cellpadding=0 border=0>
    100   <tr>
    101     <td>
    102       &nbsp;
    103     </td>
    104     <td>
    105 
    106 <p>
    107     </td>
    108   </tr>
    109 </table>
    110 <hr><h2>Member Function Documentation</h2>
    111 <a name="a2" doxytag="CallbackTimer::Run"></a><p>
    112 <table width="100%" cellpadding="2" cellspacing="0" border="0">
    113   <tr>
    114     <td class="md">
    115       <table cellpadding="0" cellspacing="0" border="0">
    116         <tr>
    117           <td class="md" colspan="4">
    118 template&lt;class Alloc&gt; </td>
    119         </tr>
    120         <tr>
    121           <td class="md" nowrap valign="top"> void CallbackTimer&lt; Alloc &gt;::Run </td>
    122           <td class="md" valign="top">(&nbsp;</td>
    123           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
    124           <td class="md" valign="top">)&nbsp;</td>
    125           <td class="md" nowrap><code> [inline, virtual]</code></td>
    126         </tr>
    127 
    128       </table>
    129     </td>
    130   </tr>
    131 </table>
    132 <table cellspacing=5 cellpadding=0 border=0>
    133   <tr>
    134     <td>
    135       &nbsp;
    136     </td>
    137     <td>
    138 
    139 <p>
    140 Handles an active object's request completion event.
    141 <p>
    142 A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.
    143 <p>
    144 The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.
    145 <p>
    146 Before calling this active object's <a class="el" href="classCallbackTimer.html#a2">Run()</a> function, the active scheduler has:
    147 <p>
    148 1. decided that this is the highest priority active object with a completed request
    149 <p>
    150 2. marked this active object's request as complete (i.e. the request is no longer outstanding)
    151 <p>
    152 <a class="el" href="classCallbackTimer.html#a2">Run()</a> runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls ExecError() to handle the leave.
    153 <p>
    154 Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's <a class="el" href="classCallbackTimer.html#a2">Run()</a> or <a class="el" href="classOsclTimerObject.html#b1">RunError()</a> functions. 
    155 <p>
    156 Implements <a class="el" href="classPVActiveBase.html#a4">PVActiveBase</a>.    </td>
    157   </tr>
    158 </table>
    159 <hr>The documentation for this class was generated from the following file:<ul>
    160 <li><a class="el" href="oscl__timer_8h-source.html">oscl_timer.h</a></ul>
    161 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
    162 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
    163 </small></address>
    164 </body>
    165 </html>
    166