<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::Event Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_event.html">Event</a></div>
<h1>ost::Event Class Reference</h1><!-- doxytag: class="ost::Event" -->The <a class="el" href="classost_1_1_event.html">Event</a> class implements a feature originally found in the WIN32 API; event <a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">notification.Thread</a> synchornization on event notification.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<a href="classost_1_1_event-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#f92ddd30a5b7b2c7af47f6bacf15941a">Event</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#ff4748ff1779334b3513cbb93d7576e8">~Event</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#67e76860dfae2ceb07feae427566ed1a">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Once signaled, the <a class="el" href="classost_1_1_event.html">Event</a> class must be "reset" before responding to a new signal. <a href="#67e76860dfae2ceb07feae427566ed1a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#1a41fd6223003aaec5381fd2205ff030">signal</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal the event for the waiting thread. <a href="#1a41fd6223003aaec5381fd2205ff030"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#bb0e6f5a8787691c2d4cc5bb10fa74e3">wait</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait either for the event to be signaled by another thread or for the specified timeout duration. <a href="#bb0e6f5a8787691c2d4cc5bb10fa74e3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#cd85c211c5e6ef9d33fb9b66a9ac097f">wait</a> (void)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_event.html">Event</a> class implements a feature originally found in the WIN32 API; event <a class="el" href="namespaceost.html#1a3b6738f6f759fcb52b544a4787cbb2">notification.Thread</a> synchornization on event notification.
<p>
A target thread waits on a resetable <a class="el" href="classost_1_1_event.html">Event</a>, and one or more other threads can then signal the waiting thread to resume execution. A timeout can be used to specify a wait duration in milliseconds. The <a class="el" href="classost_1_1_event.html">Event</a> class must be reset before it can be used again as a trigger. These event objects use a trigger/reset mechanism and are related to low level conditional variables.<p>
<dl compact><dt><b>Author:</b></dt><dd>: David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f92ddd30a5b7b2c7af47f6bacf15941a"></a><!-- doxytag: member="ost::Event::Event" ref="f92ddd30a5b7b2c7af47f6bacf15941a" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Event::Event </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="ff4748ff1779334b3513cbb93d7576e8"></a><!-- doxytag: member="ost::Event::~Event" ref="ff4748ff1779334b3513cbb93d7576e8" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::Event::~Event </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="67e76860dfae2ceb07feae427566ed1a"></a><!-- doxytag: member="ost::Event::reset" ref="67e76860dfae2ceb07feae427566ed1a" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Event::reset </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Once signaled, the <a class="el" href="classost_1_1_event.html">Event</a> class must be "reset" before responding to a new signal.
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classost_1_1_event.html#1a41fd6223003aaec5381fd2205ff030">signal</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="1a41fd6223003aaec5381fd2205ff030"></a><!-- doxytag: member="ost::Event::signal" ref="1a41fd6223003aaec5381fd2205ff030" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Event::signal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Signal the event for the waiting thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="cd85c211c5e6ef9d33fb9b66a9ac097f"></a><!-- doxytag: member="ost::Event::wait" ref="cd85c211c5e6ef9d33fb9b66a9ac097f" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Event::wait </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="bb0e6f5a8787691c2d4cc5bb10fa74e3"></a><!-- doxytag: member="ost::Event::wait" ref="bb0e6f5a8787691c2d4cc5bb10fa74e3" args="(timeout_t timer)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Event::wait </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timer</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Wait either for the event to be signaled by another thread or for the specified timeout duration.
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classost_1_1_event.html#1a41fd6223003aaec5381fd2205ff030">signal</a> </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>true if signaled, false if timed out. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>timeout in milliseconds to wait for a signal. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h-source.html">thread.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
