This file is indexed.

/usr/share/doc/libucommon-dev/a00168.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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<!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::TimedEvent 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&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00168.html">TimedEvent</a>
  </div>
</div>
<div class="contents">
<h1>ucc::TimedEvent Class Reference</h1><!-- doxytag: class="ucc::TimedEvent" --><!-- doxytag: inherits="ucc::Timer" -->
<p>Event notification to manage scheduled realtime threads.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00208_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::TimedEvent:</div>
<div class="dynsection">
<div class="center"><img src="a00571.png" border="0" usemap="#ucc_1_1_timed_event_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_timed_event_inherit__map" id="ucc_1_1_timed_event_inherit__map">
<area shape="rect" id="node2" href="a00169.html" title="Timer class to use when scheduling realtime events." alt="" coords="24,5,112,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::TimedEvent:</div>
<div class="dynsection">
<div class="center"><img src="a00572.png" border="0" usemap="#ucc_1_1_timed_event_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1_timed_event_coll__map" id="ucc_1_1_timed_event_coll__map">
<area shape="rect" id="node2" href="a00169.html" title="Timer class to use when scheduling realtime events." alt="" coords="24,5,112,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"><a class="anchor" id="a34a927690eddb0ab914551b1bc1a5233"></a><!-- doxytag: member="ucc::TimedEvent::reset" ref="a34a927690eddb0ab914551b1bc1a5233" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a34a927690eddb0ab914551b1bc1a5233">reset</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reset triggered conditional. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#acb9f65c901419e55345c7731eea60aea">signal</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Signal pending event.  <a href="#acb9f65c901419e55345c7731eea60aea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a4364246075ed32bd60ffe059096b4b94">TimedEvent</a> (time_t timeout)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create event handler and timer set to trigger a timeout.  <a href="#a4364246075ed32bd60ffe059096b4b94"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a5c43250a40e36964771b15d2c5138680">TimedEvent</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create event handler and timer set to trigger a timeout.  <a href="#a5c43250a40e36964771b15d2c5138680"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac892e87e32378895aa9612e7b1694f13"></a><!-- doxytag: member="ucc::TimedEvent::TimedEvent" ref="ac892e87e32378895aa9612e7b1694f13" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#ac892e87e32378895aa9612e7b1694f13">TimedEvent</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create event handler and timer for timing of events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#ac3b4c3823c2d5b61c7e8d56c69d17d31">wait</a> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wait to be signalled or until timer expires.  <a href="#ac3b4c3823c2d5b61c7e8d56c69d17d31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04b578be5acf279fda6f6188f56a3e74"></a><!-- doxytag: member="ucc::TimedEvent::~TimedEvent" ref="a04b578be5acf279fda6f6188f56a3e74" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a04b578be5acf279fda6f6188f56a3e74">~TimedEvent</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy timer and release pending events. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a614cb2f9a9081c2eeae59dbf3002b684">reset</a> (<a class="el" href="a00168.html">TimedEvent</a> &amp;timed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event function to reset timer for external type.  <a href="#a614cb2f9a9081c2eeae59dbf3002b684"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a57abcd8384e4e21dc7fea661c654aeb3">signal</a> (<a class="el" href="a00168.html">TimedEvent</a> &amp;timed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event function for external type.  <a href="#a57abcd8384e4e21dc7fea661c654aeb3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#ac5a643f84411ddcde840e2878efbc2d4">wait</a> (<a class="el" href="a00168.html">TimedEvent</a> &amp;timed, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Event function for external type for waiting.  <a href="#ac5a643f84411ddcde840e2878efbc2d4"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#ae5a4d30256dd9fdd3620ba6e09927e61">lock</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Lock the object for wait or to manipulate derived data.  <a href="#ae5a4d30256dd9fdd3620ba6e09927e61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#af0a75b228e6f2db94111e370b6447a4a">release</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Release the object lock after waiting.  <a href="#af0a75b228e6f2db94111e370b6447a4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00168.html#a8836c3a90bc302b2f2019bb2344ca47b">sync</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Wait while locked.  <a href="#a8836c3a90bc302b2f2019bb2344ca47b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Event notification to manage scheduled realtime threads. </p>
<p>The timer is advanced to sleep threads which then wakeup either when the timer has expired or they are notified through the signal handler. This can be used to schedule and signal one-time completion handlers or for time synchronized events signaled by an asychrononous I/O or event source. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00361">361</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5c43250a40e36964771b15d2c5138680"></a><!-- doxytag: member="ucc::TimedEvent::TimedEvent" ref="a5c43250a40e36964771b15d2c5138680" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::TimedEvent::TimedEvent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create event handler and timer set to trigger a 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>&nbsp;</td><td>in milliseconds. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a4364246075ed32bd60ffe059096b4b94"></a><!-- doxytag: member="ucc::TimedEvent::TimedEvent" ref="a4364246075ed32bd60ffe059096b4b94" args="(time_t timeout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::TimedEvent::TimedEvent </td>
          <td>(</td>
          <td class="paramtype">time_t&nbsp;</td>
          <td class="paramname"> <em>timeout</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create event handler and timer set to trigger a 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>&nbsp;</td><td>in seconds. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae5a4d30256dd9fdd3620ba6e09927e61"></a><!-- doxytag: member="ucc::TimedEvent::lock" ref="ae5a4d30256dd9fdd3620ba6e09927e61" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::TimedEvent::lock </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Lock the object for wait or to manipulate derived data. </p>
<p>This is relevant to manipulations in a derived class. </p>

</div>
</div>
<a class="anchor" id="af0a75b228e6f2db94111e370b6447a4a"></a><!-- doxytag: member="ucc::TimedEvent::release" ref="af0a75b228e6f2db94111e370b6447a4a" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::TimedEvent::release </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Release the object lock after waiting. </p>
<p>This is relevent to manipulations in a derived class. </p>

</div>
</div>
<a class="anchor" id="a614cb2f9a9081c2eeae59dbf3002b684"></a><!-- doxytag: member="ucc::TimedEvent::reset" ref="a614cb2f9a9081c2eeae59dbf3002b684" args="(TimedEvent &amp;timed)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void ucc::TimedEvent::reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00168.html">TimedEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>timed</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Event function to reset timer for external type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timed</em>&nbsp;</td><td>event object to reset. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00448">448</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00168_a614cb2f9a9081c2eeae59dbf3002b684_cgraph.png" border="0" usemap="#a00168_a614cb2f9a9081c2eeae59dbf3002b684_cgraph_map" alt=""></div>
<map name="a00168_a614cb2f9a9081c2eeae59dbf3002b684_cgraph_map" id="a00168_a614cb2f9a9081c2eeae59dbf3002b684_cgraph">
<area shape="rect" id="node3" href="a00168.html#a34a927690eddb0ab914551b1bc1a5233" title="Reset triggered conditional." alt="" coords="221,5,389,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a57abcd8384e4e21dc7fea661c654aeb3"></a><!-- doxytag: member="ucc::TimedEvent::signal" ref="a57abcd8384e4e21dc7fea661c654aeb3" args="(TimedEvent &amp;timed)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void ucc::TimedEvent::signal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00168.html">TimedEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>timed</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Event function for external type. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timed</em>&nbsp;</td><td>event object to signal. </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00441">441</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00168_a57abcd8384e4e21dc7fea661c654aeb3_cgraph.png" border="0" usemap="#a00168_a57abcd8384e4e21dc7fea661c654aeb3_cgraph_map" alt=""></div>
<map name="a00168_a57abcd8384e4e21dc7fea661c654aeb3_cgraph_map" id="a00168_a57abcd8384e4e21dc7fea661c654aeb3_cgraph">
<area shape="rect" id="node3" href="a00168.html#acb9f65c901419e55345c7731eea60aea" title="Signal pending event." alt="" coords="228,5,399,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="acb9f65c901419e55345c7731eea60aea"></a><!-- doxytag: member="ucc::TimedEvent::signal" ref="acb9f65c901419e55345c7731eea60aea" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::TimedEvent::signal </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Signal pending event. </p>
<p><a class="el" href="a00093.html" title="A common base class for all managed objects.">Object</a> may be locked or unlocked. The signalling thread may choose to lock and check a condition in a derived class before signalling. </p>

</div>
</div>
<a class="anchor" id="a8836c3a90bc302b2f2019bb2344ca47b"></a><!-- doxytag: member="ucc::TimedEvent::sync" ref="a8836c3a90bc302b2f2019bb2344ca47b" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::TimedEvent::sync </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Wait while locked. </p>
<p>This can be used in more complex derived objects where we are concerned with synchronized access between the signaling and event thread. This can be used in place of wait, but lock and release methods must be used around it. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if time expired. </dd></dl>

</div>
</div>
<a class="anchor" id="ac5a643f84411ddcde840e2878efbc2d4"></a><!-- doxytag: member="ucc::TimedEvent::wait" ref="ac5a643f84411ddcde840e2878efbc2d4" args="(TimedEvent &amp;timed, timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool ucc::TimedEvent::wait </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00168.html">TimedEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>timed</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Event function for external type for waiting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timed</em>&nbsp;</td><td>event object to wait on. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>timeout</em>&nbsp;</td><td>to wait from last reset. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if signalled, false if timeout. </dd></dl>

<p>Definition at line <a class="el" href="a00208_source.html#l00457">457</a> of file <a class="el" href="a00208_source.html">thread.h</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="a00168_ac5a643f84411ddcde840e2878efbc2d4_cgraph.png" border="0" usemap="#a00168_ac5a643f84411ddcde840e2878efbc2d4_cgraph_map" alt=""></div>
<map name="a00168_ac5a643f84411ddcde840e2878efbc2d4_cgraph_map" id="a00168_ac5a643f84411ddcde840e2878efbc2d4_cgraph">
<area shape="rect" id="node3" href="a00168.html#ac3b4c3823c2d5b61c7e8d56c69d17d31" title="Wait to be signalled or until timer expires." alt="" coords="213,5,373,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="ac3b4c3823c2d5b61c7e8d56c69d17d31"></a><!-- doxytag: member="ucc::TimedEvent::wait" ref="ac3b4c3823c2d5b61c7e8d56c69d17d31" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::TimedEvent::wait </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timeout</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Wait to be signalled or until timer expires. </p>
<p>This is a wrapper for expire for simple completion events. </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>&nbsp;</td><td>to wait from last reset. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if signaled, false if timeout. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00208_source.html">thread.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&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>