\section{ost::Event Class Reference}
\label{classost_1_1_event}\index{ost::Event@{ost::Event}}
The {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})} class implements a feature originally found in the WIN32 API; event {\bf notification.Thread}{\rm (p.\,\pageref{namespaceost_1a3b6738f6f759fcb52b544a4787cbb2})} synchornization on event notification.  


{\tt \#include $<$thread.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Event} ()
\item 
virtual {\bf $\sim$Event} ()
\item 
void {\bf reset} (void)
\begin{CompactList}\small\item\em Once signaled, the {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})} class must be \char`\"{}reset\char`\"{} before responding to a new signal. \item\end{CompactList}\item 
void {\bf signal} (void)
\begin{CompactList}\small\item\em Signal the event for the waiting thread. \item\end{CompactList}\item 
bool {\bf wait} ({\bf timeout\_\-t} timer)
\begin{CompactList}\small\item\em Wait either for the event to be signaled by another thread or for the specified timeout duration. \item\end{CompactList}\item 
bool {\bf wait} (void)
\end{CompactItemize}


\subsection{Detailed Description}
The {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})} class implements a feature originally found in the WIN32 API; event {\bf notification.Thread}{\rm (p.\,\pageref{namespaceost_1a3b6738f6f759fcb52b544a4787cbb2})} synchornization on event notification. 

A target thread waits on a resetable {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})}, 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 {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})} 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.

\begin{Desc}
\item[Author:]: David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc}




\subsection{Constructor \& Destructor Documentation}
\index{ost::Event@{ost::Event}!Event@{Event}}
\index{Event@{Event}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}ost::Event::Event ()}\label{classost_1_1_event_f92ddd30a5b7b2c7af47f6bacf15941a}


\index{ost::Event@{ost::Event}!~Event@{$\sim$Event}}
\index{~Event@{$\sim$Event}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual ost::Event::$\sim$Event ()\hspace{0.3cm}{\tt  [virtual]}}\label{classost_1_1_event_ff4748ff1779334b3513cbb93d7576e8}




\subsection{Member Function Documentation}
\index{ost::Event@{ost::Event}!reset@{reset}}
\index{reset@{reset}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Event::reset (void)}\label{classost_1_1_event_67e76860dfae2ceb07feae427566ed1a}


Once signaled, the {\bf Event}{\rm (p.\,\pageref{classost_1_1_event})} class must be \char`\"{}reset\char`\"{} before responding to a new signal. 

\begin{Desc}
\item[See also:]{\bf signal}{\rm (p.\,\pageref{classost_1_1_event_1a41fd6223003aaec5381fd2205ff030})} \end{Desc}
\index{ost::Event@{ost::Event}!signal@{signal}}
\index{signal@{signal}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void ost::Event::signal (void)}\label{classost_1_1_event_1a41fd6223003aaec5381fd2205ff030}


Signal the event for the waiting thread. 

\index{ost::Event@{ost::Event}!wait@{wait}}
\index{wait@{wait}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Event::wait (void)}\label{classost_1_1_event_cd85c211c5e6ef9d33fb9b66a9ac097f}


\index{ost::Event@{ost::Event}!wait@{wait}}
\index{wait@{wait}!ost::Event@{ost::Event}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool ost::Event::wait ({\bf timeout\_\-t} {\em timer})}\label{classost_1_1_event_bb0e6f5a8787691c2d4cc5bb10fa74e3}


Wait either for the event to be signaled by another thread or for the specified timeout duration. 

\begin{Desc}
\item[See also:]{\bf signal}{\rm (p.\,\pageref{classost_1_1_event_1a41fd6223003aaec5381fd2205ff030})} \end{Desc}
\begin{Desc}
\item[Returns:]true if signaled, false if timed out. \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em timer}]timeout in milliseconds to wait for a signal. \end{description}
\end{Desc}


The documentation for this class was generated from the following file:\begin{CompactItemize}
\item 
{\bf thread.h}\end{CompactItemize}