/usr/share/doc/libucommon-dev/a00171.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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>UCommon: ucc::TimerQueue::event 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="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</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 class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00170.html">TimerQueue</a>::<a class="el" href="a00171.html">event</a>
</div>
</div>
<div class="contents">
<h1>ucc::TimerQueue::event Class Reference</h1><!-- doxytag: class="ucc::TimerQueue::event" --><!-- doxytag: inherits="ucc::Timer,ucc::LinkedList" -->
<p>A timer event object that lives on a timer queue.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00209_source.html">timers.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::TimerQueue::event:</div>
<div class="dynsection">
<div class="center"><img src="a00576.png" border="0" usemap="#ucc_1_1_timer_queue_1_1event_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_timer_queue_1_1event_inherit__map" id="ucc_1_1_timer_queue_1_1event_inherit__map">
<area shape="rect" id="node2" href="a00169.html" title="Timer class to use when scheduling realtime events." alt="" coords="5,237,93,267"/><area shape="rect" id="node4" href="a00068.html" title="A double linked list object." alt="" coords="117,237,232,267"/><area shape="rect" id="node6" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="103,160,247,189"/><area shape="rect" id="node8" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="108,83,241,112"/><area shape="rect" id="node10" href="a00093.html" title="A common base class for all managed objects." alt="" coords="128,5,221,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::TimerQueue::event:</div>
<div class="dynsection">
<div class="center"><img src="a00577.png" border="0" usemap="#ucc_1_1_timer_queue_1_1event_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_timer_queue_1_1event_coll__map" id="ucc_1_1_timer_queue_1_1event_coll__map">
<area shape="rect" id="node2" href="a00169.html" title="Timer class to use when scheduling realtime events." alt="" coords="9,395,97,424"/><area shape="rect" id="node4" href="a00068.html" title="A double linked list object." alt="" coords="121,395,236,424"/><area shape="rect" id="node6" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="91,187,235,216"/><area shape="rect" id="node13" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="179,299,317,328"/><area shape="rect" id="node8" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="96,96,229,125"/><area shape="rect" id="node10" href="a00093.html" title="A common base class for all managed objects." alt="" coords="116,5,209,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a9c77bfa7ee15ee08e7f17a231b03d336">arm</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Arm event to trigger at specified timeout. <a href="#a9c77bfa7ee15ee08e7f17a231b03d336"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#aa65472130549e729fd81f4a291fc52b6">attach</a> (<a class="el" href="a00170.html">TimerQueue</a> *<a class="el" href="a00109.html">queue</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach event to a timer queue. <a href="#aa65472130549e729fd81f4a291fc52b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab027fb75155c73ea7b01947554038684"></a><!-- doxytag: member="ucc::TimerQueue::event::detach" ref="ab027fb75155c73ea7b01947554038684" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#ab027fb75155c73ea7b01947554038684">detach</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detach event from a timer queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aab9bd2d2376f69918165843c9901f432"></a><!-- doxytag: member="ucc::TimerQueue::event::disarm" ref="aab9bd2d2376f69918165843c9901f432" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#aab9bd2d2376f69918165843c9901f432">disarm</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disarm event. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a053b5fa92f8c818b662880a998bb515d">get</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00167.html" title="The Time class uses a integer representation of the current time.">Time</a> remaining until expired. <a href="#a053b5fa92f8c818b662880a998bb515d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00170.html">TimerQueue</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#ada75b5c938a4a7a53e2f7f2e2d7537df">getQueue</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the timer queue we are attached to. <a href="#ada75b5c938a4a7a53e2f7f2e2d7537df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#af159beceace1f1fa0b9cee679b4d4ea8">isExpired</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if event has expired. <a href="#af159beceace1f1fa0b9cee679b4d4ea8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a487a912ef5e3de9915e47b20776d2861"></a><!-- doxytag: member="ucc::TimerQueue::event::update" ref="a487a912ef5e3de9915e47b20776d2861" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a487a912ef5e3de9915e47b20776d2861">update</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Notify timer queue that the timer has been updated. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad463401968d7b6a679ead64c683736c1"></a><!-- doxytag: member="ucc::TimerQueue::event::~event" ref="ad463401968d7b6a679ead64c683736c1" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#ad463401968d7b6a679ead64c683736c1">~event</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Detaches from queue when destroyed. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a82dfa26dc1f7b08332d13afe6b1fd443">event</a> (<a class="el" href="a00170.html">TimerQueue</a> *<a class="el" href="a00109.html">queue</a>, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an armed timer event object and attach to queue. <a href="#a82dfa26dc1f7b08332d13afe6b1fd443"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a11442ff3e53a4d820c65d0b66f9f75c4">event</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> expire)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a timer event object and initially arm. <a href="#a11442ff3e53a4d820c65d0b66f9f75c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9534aec8bace6c58db173df4526c6401"></a><!-- doxytag: member="ucc::TimerQueue::event::expired" ref="a9534aec8bace6c58db173df4526c6401" args="(void)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a9534aec8bace6c58db173df4526c6401">expired</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event method to call in derived class when timer expires. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00171.html#a62fbff888d8a6b1a15b3745b674b6117">timeout</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Expected next timeout for the timer. <a href="#a62fbff888d8a6b1a15b3745b674b6117"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a865df28c10927729363ac18d3d83f35b"></a><!-- doxytag: member="ucc::TimerQueue::event::TimerQueue" ref="a865df28c10927729363ac18d3d83f35b" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>TimerQueue</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A timer event object that lives on a timer queue. </p>
<p><a class="el" href="a00169.html" title="Timer class to use when scheduling realtime events.">Timer</a> events are triggered through the timer queue's expire method. <a class="el" href="a00169.html" title="Timer class to use when scheduling realtime events.">Timer</a> events also modify the queue when they are changed, particularly to force re-evaluation of the expiration period. This class is not used by itself but rather as a base class for a timer event object. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00209_source.html#l00262">262</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a11442ff3e53a4d820c65d0b66f9f75c4"></a><!-- doxytag: member="ucc::TimerQueue::event::event" ref="a11442ff3e53a4d820c65d0b66f9f75c4" args="(timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::TimerQueue::event::event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a timer event object and initially arm. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>timer in specified milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a82dfa26dc1f7b08332d13afe6b1fd443"></a><!-- doxytag: member="ucc::TimerQueue::event::event" ref="a82dfa26dc1f7b08332d13afe6b1fd443" args="(TimerQueue *queue, timeout_t expire)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::TimerQueue::event::event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00170.html">TimerQueue</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>expire</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an armed timer event object and attach to queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to add event to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>expire</em> </td><td>timer in specified milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9c77bfa7ee15ee08e7f17a231b03d336"></a><!-- doxytag: member="ucc::TimerQueue::event::arm" ref="a9c77bfa7ee15ee08e7f17a231b03d336" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::TimerQueue::event::arm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Arm event to trigger at specified timeout. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>to expire and trigger. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa65472130549e729fd81f4a291fc52b6"></a><!-- doxytag: member="ucc::TimerQueue::event::attach" ref="aa65472130549e729fd81f4a291fc52b6" args="(TimerQueue *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucc::TimerQueue::event::attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00170.html">TimerQueue</a> * </td>
<td class="paramname"> <em>queue</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Attach event to a timer queue. </p>
<p>Detaches from previous list if already attached elsewhere. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>to attach to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a053b5fa92f8c818b662880a998bb515d"></a><!-- doxytag: member="ucc::TimerQueue::event::get" ref="a053b5fa92f8c818b662880a998bb515d" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::TimerQueue::event::get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="a00167.html" title="The Time class uses a integer representation of the current time.">Time</a> remaining until expired. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>milliseconds until timer expires. </dd></dl>
<p>Reimplemented from <a class="el" href="a00169.html#a92aac4f410ee7fb503c67b059da00a00">ucc::Timer</a>.</p>
<p>Definition at line <a class="el" href="a00209_source.html#l00332">332</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
</div>
</div>
<a class="anchor" id="ada75b5c938a4a7a53e2f7f2e2d7537df"></a><!-- doxytag: member="ucc::TimerQueue::event::getQueue" ref="ada75b5c938a4a7a53e2f7f2e2d7537df" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00170.html">TimerQueue</a>* ucc::TimerQueue::event::getQueue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the timer queue we are attached to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>timer queue or NULL if not attached. </dd></dl>
<p>Definition at line <a class="el" href="a00209_source.html#l00344">344</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
</div>
</div>
<a class="anchor" id="af159beceace1f1fa0b9cee679b4d4ea8"></a><!-- doxytag: member="ucc::TimerQueue::event::isExpired" ref="af159beceace1f1fa0b9cee679b4d4ea8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucc::TimerQueue::event::isExpired </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if event has expired. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if expired. </dd></dl>
<p>Reimplemented from <a class="el" href="a00169.html#a1a6034ffe4d6223bdc92585e2f7d971c">ucc::Timer</a>.</p>
<p>Definition at line <a class="el" href="a00209_source.html#l00325">325</a> of file <a class="el" href="a00209_source.html">timers.h</a>.</p>
</div>
</div>
<a class="anchor" id="a62fbff888d8a6b1a15b3745b674b6117"></a><!-- doxytag: member="ucc::TimerQueue::event::timeout" ref="a62fbff888d8a6b1a15b3745b674b6117" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::TimerQueue::event::timeout </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Expected next timeout for the timer. </p>
<p>This may be overriden for strategy purposes when evaluted by timer queue's expire. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>milliseconds until timer next triggers. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00209_source.html">timers.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:52 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|