Event(3cc) · carta

NAME

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

SYNOPSIS

#include <thread.h>

Public Methods

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. 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 <[email protected]>

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.