CwclEvent Class Reference

The class represents an event synchronization object. More...

#include <wclSync.h>

Inheritance diagram for CwclEvent:

Public Member Functions
virtual unsigned long	WaitOne () override
	Waits until the object is in the signaled state.
virtual unsigned long	WaitOne (const unsigned long Timeout) override
	Waits until the object is in the signaled state or the time-out interval elapses.
bool	ResetEvent ()
	Sets the event object to the nonsignaled state.
bool	SetEvent ()
	Sets the event object to the signaled state.
Public Member Functions inherited from CwclNamedSyncObject
virtual	~CwclNamedSyncObject ()
	Frees the named synchronization object.
Public Member Functions inherited from CwclWaitableSyncObject
virtual	~CwclWaitableSyncObject ()
	Frees the waitable synchronization object.
HANDLE	GetHandle () const
	Gets the system dependent synchronization object handle.
	__declspec (property(get=GetHandle)) HANDLE Handle
	Gets the system dependent synchronization object handle.
Public Member Functions inherited from CwclSyncObject
virtual	~CwclSyncObject ()
	Frees the synchronization object.

Static Public Member Functions
static CwclEvent *	Create (const bool ManualReset)
	Creates an unnamed event object.
static CwclEvent *	Create (const bool ManualReset, const tstring &Name)
	Creates or opens a named event object.
static CwclEvent *	Create (const bool ManualReset, const tstring &Name, bool &Exist)
	Creates or opens a named event object.
static CwclEvent *	Open (const tstring &Name)
	Opens an existing named event object.
Static Public Member Functions inherited from CwclWaitableSyncObject
static unsigned long	WaitAll (const unsigned long Count, CwclWaitableSyncObject **const Objects)
	Waits until all of the specified objects are in the signaled state.
static unsigned long	WaitAll (const unsigned long Count, CwclWaitableSyncObject **const Objects, const unsigned long Timeout)
	Waits until all of the specified objects are in the signaled state or the time-out interval elapses.
static unsigned long	WaitAny (const unsigned long Count, CwclWaitableSyncObject **const Objects)
	Waits until one or all of the specified objects are in the signaled state.
static unsigned long	WaitAny (const unsigned long Count, CwclWaitableSyncObject **const Objects, const unsigned long Timeout)
	Waits until one of the specified objects are in the signaled state or the time-out interval elapses.

Protected Member Functions
	CwclEvent (const HANDLE Handle)
	Creates new event object.
Protected Member Functions inherited from CwclNamedSyncObject
	CwclNamedSyncObject (const HANDLE Handle)
	Creates new synchronization object.
Protected Member Functions inherited from CwclWaitableSyncObject
	CwclWaitableSyncObject (const HANDLE Handle)
	Creates new synchronization object.
Protected Member Functions inherited from CwclSyncObject
	CwclSyncObject ()
	Creates new synchronization object.

Additional Inherited Members
Static Protected Member Functions inherited from CwclNamedSyncObject
static tstring	MakeUniqueName (const tstring &Name)
	Makes unique synchronization object name.

Detailed Description

The class represents an event synchronization object.

An event object is a synchronization object whose state can be explicitly set to signaled by use of the SetEvent function.

See also

CwclNamedSyncObject