---

Event Class Reference

The Event class implements a feature originally found in the WIN32 API; event notification. Thread synchornization on event notification. More...

#include <thread.h>

List of all members.

Public Methods
	Event ()
virtual	~Event ()
void	Reset (void)
	Once signaled, the Event class must be "reset" before responding to a new signal. More...
void	Signal (void)
	Signal the event for the waiting thread. More...
bool	Wait (timeout_t timer)
	Wait either for the event to be signaled by another thread or for the specified timeout duration. More...
bool	Wait (void)

---

Detailed Description

The Event class implements a feature originally found in the WIN32 API; event notification. Thread synchornization on event notification.

A target thread waits on a resetable 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 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.

@author: David Sugar <dyfet@ostel.com>

---

Constructor & Destructor Documentation

Event::Event (    )

virtual Event::~Event (    )  [virtual]

---

Member Function Documentation

void Event::Reset (  void   )

Once signaled, the Event class must be "reset" before responding to a new signal. See also: Signal

void Event::Signal (  void   )

Signal the event for the waiting thread.

bool Event::Wait (  void   )

bool Event::Wait (  timeout_t   timer )

Wait either for the event to be signaled by another thread or for the specified timeout duration. See also: Signal Returns: true if signaled, false if timed out. Parameters: timer   timeout in milliseconds to wait for a signal.

---

The documentation for this class was generated from the following file:

• thread.h

---