<!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: ucommon::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 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="a00208.html">ucommon</a>::<a class="el" href="a00161.html">TimedEvent</a>
</div>
</div>
<div class="contents">
<h1>ucommon::TimedEvent Class Reference</h1><!-- doxytag: class="ucommon::TimedEvent" --><!-- doxytag: inherits="ucommon::Timer" -->
<p>Event notification to manage scheduled realtime threads.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00202_source.html">thread.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucommon::TimedEvent:</div>
<div class="dynsection">
<div class="center"><img src="a00555.png" border="0" usemap="#ucommon_1_1_timed_event_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_timed_event_inherit__map" id="ucommon_1_1_timed_event_inherit__map">
<area shape="rect" id="node2" href="a00162.html" title="Timer class to use when scheduling realtime events." alt="" coords="29,5,192,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucommon::TimedEvent:</div>
<div class="dynsection">
<div class="center"><img src="a00556.png" border="0" usemap="#ucommon_1_1_timed_event_coll__map" alt="Collaboration graph"/></div>
<map name="ucommon_1_1_timed_event_coll__map" id="ucommon_1_1_timed_event_coll__map">
<area shape="rect" id="node2" href="a00162.html" title="Timer class to use when scheduling realtime events." alt="" coords="29,5,192,32"/></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="a1eb9948289077588c63393f36e039a1c"></a><!-- doxytag: member="ucommon::TimedEvent::reset" ref="a1eb9948289077588c63393f36e039a1c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a1eb9948289077588c63393f36e039a1c">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset triggered conditional. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a76d9fc78d5837b3442a8644af7f82957">signal</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal pending event. <a href="#a76d9fc78d5837b3442a8644af7f82957"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a0e9051d3bfefc59f255387fde5a1d215">TimedEvent</a> (time_t timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create event handler and timer set to trigger a timeout. <a href="#a0e9051d3bfefc59f255387fde5a1d215"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#af6af808fae4d80802dc316d92b45e8eb">TimedEvent</a> (<a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create event handler and timer set to trigger a timeout. <a href="#af6af808fae4d80802dc316d92b45e8eb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a602bde0fa74198c0819973df2cf53667"></a><!-- doxytag: member="ucommon::TimedEvent::TimedEvent" ref="a602bde0fa74198c0819973df2cf53667" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a602bde0fa74198c0819973df2cf53667">TimedEvent</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create event handler and timer for timing of events. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e457d97fbd0bb4bcc88700b7be14c0c"></a><!-- doxytag: member="ucommon::TimedEvent::wait" ref="a5e457d97fbd0bb4bcc88700b7be14c0c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a5e457d97fbd0bb4bcc88700b7be14c0c">wait</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A simple wait until triggered. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a7e3a308a10177488b16b0082ba840e1d">wait</a> (<a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait to be signalled or until timer expires. <a href="#a7e3a308a10177488b16b0082ba840e1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9d7cd84beb53694e23d175452c1218d"></a><!-- doxytag: member="ucommon::TimedEvent::~TimedEvent" ref="aa9d7cd84beb53694e23d175452c1218d" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#aa9d7cd84beb53694e23d175452c1218d">~TimedEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#ace2fc944cf0bdd2fa0302c40ca22aeca">reset</a> (<a class="el" href="a00161.html">TimedEvent</a> &timed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event function to reset timer for external type. <a href="#ace2fc944cf0bdd2fa0302c40ca22aeca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a216b48cf3b744b14ad93640c17870cbd">signal</a> (<a class="el" href="a00161.html">TimedEvent</a> &timed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event function for external type. <a href="#a216b48cf3b744b14ad93640c17870cbd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a34ace00ce72ea3b56a017f154d1865d5">wait</a> (<a class="el" href="a00161.html">TimedEvent</a> &timed, <a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Event function for external type for waiting. <a href="#a34ace00ce72ea3b56a017f154d1865d5"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a5f1174f733ce01a24753ffff73851336">lock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lock the object for wait or to manipulate derived data. <a href="#a5f1174f733ce01a24753ffff73851336"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#afbb5e87832b3757288029ec0f8298b77">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the object lock after waiting. <a href="#afbb5e87832b3757288029ec0f8298b77"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00161.html#a5f20fff994b46385579d41249c67cbcb">sync</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait while locked. <a href="#a5f20fff994b46385579d41249c67cbcb"></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 <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00202_source.html#l00365">365</a> of file <a class="el" href="a00202_source.html">thread.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af6af808fae4d80802dc316d92b45e8eb"></a><!-- doxytag: member="ucommon::TimedEvent::TimedEvent" ref="af6af808fae4d80802dc316d92b45e8eb" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::TimedEvent::TimedEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </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> </td><td>in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0e9051d3bfefc59f255387fde5a1d215"></a><!-- doxytag: member="ucommon::TimedEvent::TimedEvent" ref="a0e9051d3bfefc59f255387fde5a1d215" args="(time_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucommon::TimedEvent::TimedEvent </td>
<td>(</td>
<td class="paramtype">time_t </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </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> </td><td>in seconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5f1174f733ce01a24753ffff73851336"></a><!-- doxytag: member="ucommon::TimedEvent::lock" ref="a5f1174f733ce01a24753ffff73851336" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::TimedEvent::lock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </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="afbb5e87832b3757288029ec0f8298b77"></a><!-- doxytag: member="ucommon::TimedEvent::release" ref="afbb5e87832b3757288029ec0f8298b77" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::TimedEvent::release </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </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="ace2fc944cf0bdd2fa0302c40ca22aeca"></a><!-- doxytag: member="ucommon::TimedEvent::reset" ref="ace2fc944cf0bdd2fa0302c40ca22aeca" args="(TimedEvent &timed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucommon::TimedEvent::reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00161.html">TimedEvent</a> & </td>
<td class="paramname"> <em>timed</em></td>
<td> ) </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> </td><td>event object to reset. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00202_source.html#l00457">457</a> of file <a class="el" href="a00202_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="a00161_ace2fc944cf0bdd2fa0302c40ca22aeca_cgraph.png" border="0" usemap="#a00161_ace2fc944cf0bdd2fa0302c40ca22aeca_cgraph_map" alt=""></div>
<map name="a00161_ace2fc944cf0bdd2fa0302c40ca22aeca_cgraph_map" id="a00161_ace2fc944cf0bdd2fa0302c40ca22aeca_cgraph">
<area shape="rect" id="node3" href="a00161.html#a1eb9948289077588c63393f36e039a1c" title="Reset triggered conditional." alt="" coords="336,5,619,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a216b48cf3b744b14ad93640c17870cbd"></a><!-- doxytag: member="ucommon::TimedEvent::signal" ref="a216b48cf3b744b14ad93640c17870cbd" args="(TimedEvent &timed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void ucommon::TimedEvent::signal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00161.html">TimedEvent</a> & </td>
<td class="paramname"> <em>timed</em></td>
<td> ) </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> </td><td>event object to signal. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00202_source.html#l00450">450</a> of file <a class="el" href="a00202_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="a00161_a216b48cf3b744b14ad93640c17870cbd_cgraph.png" border="0" usemap="#a00161_a216b48cf3b744b14ad93640c17870cbd_cgraph_map" alt=""></div>
<map name="a00161_a216b48cf3b744b14ad93640c17870cbd_cgraph_map" id="a00161_a216b48cf3b744b14ad93640c17870cbd_cgraph">
<area shape="rect" id="node3" href="a00161.html#a76d9fc78d5837b3442a8644af7f82957" title="Signal pending event." alt="" coords="348,5,639,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a76d9fc78d5837b3442a8644af7f82957"></a><!-- doxytag: member="ucommon::TimedEvent::signal" ref="a76d9fc78d5837b3442a8644af7f82957" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ucommon::TimedEvent::signal </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal pending event. </p>
<p>Object 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="a5f20fff994b46385579d41249c67cbcb"></a><!-- doxytag: member="ucommon::TimedEvent::sync" ref="a5f20fff994b46385579d41249c67cbcb" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::TimedEvent::sync </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </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="a34ace00ce72ea3b56a017f154d1865d5"></a><!-- doxytag: member="ucommon::TimedEvent::wait" ref="a34ace00ce72ea3b56a017f154d1865d5" args="(TimedEvent &timed, timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ucommon::TimedEvent::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00161.html">TimedEvent</a> & </td>
<td class="paramname"> <em>timed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td><td> </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> </td><td>event object to wait on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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="a00202_source.html#l00466">466</a> of file <a class="el" href="a00202_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="a00161_a34ace00ce72ea3b56a017f154d1865d5_cgraph.png" border="0" usemap="#a00161_a34ace00ce72ea3b56a017f154d1865d5_cgraph_map" alt=""></div>
<map name="a00161_a34ace00ce72ea3b56a017f154d1865d5_cgraph_map" id="a00161_a34ace00ce72ea3b56a017f154d1865d5_cgraph">
<area shape="rect" id="node3" href="a00161.html#a7e3a308a10177488b16b0082ba840e1d" title="Wait to be signalled or until timer expires." alt="" coords="325,5,597,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a7e3a308a10177488b16b0082ba840e1d"></a><!-- doxytag: member="ucommon::TimedEvent::wait" ref="a7e3a308a10177488b16b0082ba840e1d" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ucommon::TimedEvent::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00194.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </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> </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="a00202_source.html">thread.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:10 2011 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>
