blob: c03bb8b57b2e018e5e9340ccda2041c6cbd86dc3 [file] [log] [blame]
<!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> TemplateCallbackTimer&lt; Alloc &gt; 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> &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>
<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>
<p>
<p>Inheritance diagram for CallbackTimer&lt; Alloc &gt;:
<p><center><img src="classCallbackTimer.png" usemap="#CallbackTimer< Alloc >_map" border="0" alt=""></center>
<map name="CallbackTimer< Alloc >_map">
<area href="classOsclTimerObject.html" alt="OsclTimerObject" shape="rect" coords="77,112,222,136">
<area href="classHeapBase.html" alt="HeapBase" shape="rect" coords="0,56,145,80">
<area href="classPVActiveBase.html" alt="PVActiveBase" shape="rect" coords="155,56,300,80">
<area href="class__OsclHeapBase.html" alt="_OsclHeapBase" shape="rect" coords="0,0,145,24">
</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>&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>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classCallbackTimer.html#a1">~CallbackTimer</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classCallbackTimer.html#a2">Run</a> ()</td></tr>
</table>
<h3>template&lt;class Alloc&gt;<br>
class CallbackTimer&lt; Alloc &gt;</h3>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="CallbackTimer::CallbackTimer"></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" colspan="4">
template&lt;class Alloc&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> CallbackTimer&lt; Alloc &gt;::CallbackTimer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classCallbackTimerObserver.html">CallbackTimerObserver</a> &amp;&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aContainer</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int32&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aPriority</em> = OsclActiveObject::EPriorityNominal</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="CallbackTimer::~CallbackTimer"></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" colspan="4">
template&lt;class Alloc&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> CallbackTimer&lt; Alloc &gt;::~CallbackTimer </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a2" doxytag="CallbackTimer::Run"></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" colspan="4">
template&lt;class Alloc&gt; </td>
</tr>
<tr>
<td class="md" nowrap valign="top"> void CallbackTimer&lt; Alloc &gt;::Run </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Handles an active object's request completion event.
<p>
A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.
<p>
The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.
<p>
Before calling this active object's <a class="el" href="classCallbackTimer.html#a2">Run()</a> function, the active scheduler has:
<p>
1. decided that this is the highest priority active object with a completed request
<p>
2. marked this active object's request as complete (i.e. the request is no longer outstanding)
<p>
<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.
<p>
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.
<p>
Implements <a class="el" href="classPVActiveBase.html#a4">PVActiveBase</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__timer_8h-source.html">oscl_timer.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>