ost::event(3)

NAME

ost::Event - The Event class implements a feature originally found in the WIN32 API; event notification.

SYNOPSIS

#include <thread.h>
Public Member Functions
Event ()
virtual ~Event ()
void reset (void)
    Once signaled, the Event class must be 'reset' before responding to
    a new signal.
void signal (void)
    Signal the event for the waiting thread.
bool wait (timeout_t timer)
    Wait either for the event to be signaled by another thread or for
    the specified timeout duration.
bool wait (void)

Detailed Description

The Event class implements a feature originally found in the WIN32 API;
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> Thread synchornization on event notification.

Constructor & Destructor Documentation

ost::Event::Event ()
virtual ost::Event::~Event () [virtual]

Member Function Documentation

void ost::Event::reset (void)

Once signaled, the Event class must be 'reset' before responding to a new signal.

See also:

signal

void ost::Event::signal (void)

Signal the event for the waiting thread.

bool ost::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.

bool ost::Event::wait (void)

Author

Generated automatically by Doxygen for GNU CommonC++ from the source
code.

GNU CommonC++ 25 Aug 2008 ost::Event(3)