Event Class Reference


Public Member Functions
	Event (bool manualReset, bool initialState)
	~Event ()
void	set ()
void	reset ()
void	wait ()

Detailed Description

Object to be used to synchronize threads

An event is signalled with set(). If the new event is a manual reset event, it remains signalled until it is reset with reset(). An auto reset event remains signalled until a single thread has waited for it, at which time the event handle is automatically reset to unsignalled.

Constructor & Destructor Documentation

Event ( bool manualReset,

bool initialState

)

Creates a new event

Parameters:

manualReset Specifies whether the new event has manual or auto reset behaviour.

initialState Specifies whether the new event handle is initially signalled or not

~Event ( )

Destroy the event

Member Function Documentation

void reset ( )

Resets the event to the unsignalled state

void set ( )

Sets the event to the signalled state.
If the event is a manual reset event, it remains signalled until it is reset with Reset(). An auto reset event remains signalled until a single thread has waited for it, at which time the event is automatically reset to unsignalled.

void wait ( )

Wait for the event to be set
This method immediatly returns if the event is already set

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

event.h
event.cpp

Event Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation