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
|
<!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: CallbackTimer< Alloc > Class Template 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>CallbackTimer< Alloc > Class Template Reference</h1><!-- doxytag: class="CallbackTimer" --><!-- doxytag: inherits="OsclTimerObject" -->
<p><code>#include <<a class="el" href="oscl__timer_8h_source.html">oscl_timer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CallbackTimer< Alloc >:</div>
<div class="dynsection">
<div class="center">
<img src="classCallbackTimer.png" usemap="#CallbackTimer< Alloc >_map" alt=""/>
<map id="CallbackTimer< Alloc >_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>
</div>
</div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackTimer.html#a9595de73dd000415ccdb8b6fb62097ab">CallbackTimer</a> (<a class="el" href="classCallbackTimerObserver.html">CallbackTimerObserver</a> &aContainer, const char *name, int32 aPriority=OsclActiveObject::EPriorityNominal)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackTimer.html#ac696b0d4f379ad3ef0ecb14e78ccfa65">~CallbackTimer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCallbackTimer.html#ac1d656511c8a5ee2c9e4c0a8c07e04fb">Run</a> ()</td></tr>
</table>
<h3>template<class Alloc><br/>
class CallbackTimer< Alloc ></h3>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9595de73dd000415ccdb8b6fb62097ab"></a><!-- doxytag: member="CallbackTimer::CallbackTimer" ref="a9595de73dd000415ccdb8b6fb62097ab" args="(CallbackTimerObserver &aContainer, const char *name, int32 aPriority=OsclActiveObject::EPriorityNominal)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Alloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCallbackTimer.html">CallbackTimer</a>< Alloc >::<a class="el" href="classCallbackTimer.html">CallbackTimer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCallbackTimerObserver.html">CallbackTimerObserver</a> & </td>
<td class="paramname"> <em>aContainer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"> <em>aPriority</em> = <code>OsclActiveObject::EPriorityNominal</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classOsclTimerObject.html#a5a183966f3d756837cc1a2a8e12afae3">OsclTimerObject::AddToScheduler()</a>.</p>
</div>
</div>
<a class="anchor" id="ac696b0d4f379ad3ef0ecb14e78ccfa65"></a><!-- doxytag: member="CallbackTimer::~CallbackTimer" ref="ac696b0d4f379ad3ef0ecb14e78ccfa65" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Alloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCallbackTimer.html">CallbackTimer</a>< Alloc >::~<a class="el" href="classCallbackTimer.html">CallbackTimer</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>References <a class="el" href="classOsclTimerObject.html#a66f99ee9c174dc2c93d791cd95d78851">OsclTimerObject::RemoveFromScheduler()</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac1d656511c8a5ee2c9e4c0a8c07e04fb"></a><!-- doxytag: member="CallbackTimer::Run" ref="ac1d656511c8a5ee2c9e4c0a8c07e04fb" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Alloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classCallbackTimer.html">CallbackTimer</a>< Alloc >::Run </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles an active object's request completion event.</p>
<p>A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.</p>
<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>
<p>Before calling this active object's <a class="el" href="classCallbackTimer.html#ac1d656511c8a5ee2c9e4c0a8c07e04fb">Run()</a> function, the active scheduler has:</p>
<p>1. decided that this is the highest priority active object with a completed request</p>
<p>2. marked this active object's request as complete (i.e. the request is no longer outstanding)</p>
<p><a class="el" href="classCallbackTimer.html#ac1d656511c8a5ee2c9e4c0a8c07e04fb">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>
<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#ac1d656511c8a5ee2c9e4c0a8c07e04fb">Run()</a> or <a class="el" href="classOsclTimerObject.html#a64920e5445a1b9166c33680e827b3270">RunError()</a> functions. </p>
<p>Implements <a class="el" href="classPVActiveBase.html#aefdcb83177c92ddf6c2729d034288f9d">PVActiveBase</a>.</p>
<p>References <a class="el" href="oscl__aostatus_8h_source.html#l00024">OSCL_REQUEST_ERR_NONE</a>, <a class="el" href="classOsclTimerObject.html#a144cad783a7dd31bfb6c6bd37cc3f236">OsclTimerObject::Status()</a>, and <a class="el" href="classCallbackTimerObserver.html#a7ad6634357f0af8146f04d4c8056bcaa">CallbackTimerObserver::TimerBaseElapsed()</a>.</p>
</div>
</div>
<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></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>
|
