<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::Event Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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>Classes</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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_event.html">Event</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_event-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::Event Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classost_1_1_event.html" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">Event</a> class implements a feature originally found in the WIN32 API; event notification.
<a href="classost_1_1_event.html#details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af92ddd30a5b7b2c7af47f6bacf15941a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#af92ddd30a5b7b2c7af47f6bacf15941a">Event</a> ()</td></tr>
<tr class="separator:af92ddd30a5b7b2c7af47f6bacf15941a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff4748ff1779334b3513cbb93d7576e8"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#aff4748ff1779334b3513cbb93d7576e8">~Event</a> ()</td></tr>
<tr class="separator:aff4748ff1779334b3513cbb93d7576e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67e76860dfae2ceb07feae427566ed1a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#a67e76860dfae2ceb07feae427566ed1a">reset</a> (void)</td></tr>
<tr class="memdesc:a67e76860dfae2ceb07feae427566ed1a"><td class="mdescLeft"> </td><td class="mdescRight">Once signaled, the <a class="el" href="classost_1_1_event.html" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">Event</a> class must be "reset" before responding to a new signal. <a href="#a67e76860dfae2ceb07feae427566ed1a">More...</a><br/></td></tr>
<tr class="separator:a67e76860dfae2ceb07feae427566ed1a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a41fd6223003aaec5381fd2205ff030"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#a1a41fd6223003aaec5381fd2205ff030">signal</a> (void)</td></tr>
<tr class="memdesc:a1a41fd6223003aaec5381fd2205ff030"><td class="mdescLeft"> </td><td class="mdescRight">Signal the event for the waiting thread. <a href="#a1a41fd6223003aaec5381fd2205ff030">More...</a><br/></td></tr>
<tr class="separator:a1a41fd6223003aaec5381fd2205ff030"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb0e6f5a8787691c2d4cc5bb10fa74e3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#abb0e6f5a8787691c2d4cc5bb10fa74e3">wait</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr class="memdesc:abb0e6f5a8787691c2d4cc5bb10fa74e3"><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="#abb0e6f5a8787691c2d4cc5bb10fa74e3">More...</a><br/></td></tr>
<tr class="separator:abb0e6f5a8787691c2d4cc5bb10fa74e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd85c211c5e6ef9d33fb9b66a9ac097f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_event.html#acd85c211c5e6ef9d33fb9b66a9ac097f">wait</a> (void)</td></tr>
<tr class="separator:acd85c211c5e6ef9d33fb9b66a9ac097f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classost_1_1_event.html" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">Event</a> class implements a feature originally found in the WIN32 API; event notification. </p>
<p>A target thread waits on a resetable <a class="el" href="classost_1_1_event.html" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">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" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">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 class="section author"><dt>Author</dt><dd>: David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> <a class="el" href="classost_1_1_thread.html" title="Every thread of execution in an application is created by instantiating an object of a class derived ...">Thread</a> synchornization on event notification. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="af92ddd30a5b7b2c7af47f6bacf15941a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Event::Event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aff4748ff1779334b3513cbb93d7576e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ost::Event::~Event </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a67e76860dfae2ceb07feae427566ed1a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Event::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Once signaled, the <a class="el" href="classost_1_1_event.html" title="The Event class implements a feature originally found in the WIN32 API; event notification. ">Event</a> class must be "reset" before responding to a new signal. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classost_1_1_event.html#a1a41fd6223003aaec5381fd2205ff030" title="Signal the event for the waiting thread. ">signal</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a1a41fd6223003aaec5381fd2205ff030"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Event::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 the event for the waiting thread. </p>
</div>
</div>
<a class="anchor" id="abb0e6f5a8787691c2d4cc5bb10fa74e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Event::wait </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"><em>timer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait either for the event to be signaled by another thread or for the specified timeout duration. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classost_1_1_event.html#a1a41fd6223003aaec5381fd2205ff030" title="Signal the event for the waiting thread. ">signal</a> </dd></dl>
<dl class="section return"><dt>Returns</dt><dd>true if signaled, false if timed out. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timer</td><td>timeout in milliseconds to wait for a signal. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acd85c211c5e6ef9d33fb9b66a9ac097f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Event::wait </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:58 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
