The C++ framework for developing highly scalable, high performance servers on Windows platforms.

• Home
• What
• Why
• How
• Who
• Products
• Pricing
• Blog
• Contact

Search

CEvent Class Reference
[Win32 Synchronization primitives]

Inheritance diagram for CEvent:

[legend]

Collaboration diagram for CEvent:

[legend]

List of all members.

Public Types
enum	ResetType { ManualReset, AutoReset }
	Specify the type of event object. More...
enum	InitialState { Signaled, NonSignaled }
	Specify the initial state of an event object. More...
Public Member Functions
	CEvent (ResetType resetType, InitialState initialState)
	CEvent (const CEvent &rhs)
CEvent &	operator= (const CEvent &rhs)
void	Reset ()
	Reset the event to the unsignalled state.
void	Set ()
	Set the event to the signalled state.
HANDLE	GetWaitHandle () const override
	Access a HANDLE to wait on by passing it to one of the Wait Functions.
void	Wait () const override
	Wait indefinitely for the object to become signalled.
bool	Wait (Milliseconds timeout) const override
	Wait, with a time limit, for the object to become signalled. If you want to wait for 0 milliseconds and you get an "ambiguous call" with the Handle version then use IsSignalled() which is the same as Wait(0).
virtual bool	IsSignalled () const
	Returns true if the object is signalled and false if it isn't; doesn't block.
Static Public Member Functions
static void	WaitForHandle (HANDLE handle)
	Wait indefinitely for the supplied handle to become signalled.
static bool	WaitForHandle (HANDLE handle, Milliseconds timeout)
	Wait, with a time limit, for the supplied handle to become signalled.
static DWORD	WaitForMultipleHandles (DWORD numHandles, HANDLE *pHandles, bool waitAll, Milliseconds timeout)
static bool	WaitWithMessageLoop (HANDLE handle, Milliseconds timeout)
static bool	WaitWithMessageLoop (HANDLE handle, Milliseconds timeout, DWORD removeFlags)
static bool	WaitWithMessageLoop (DWORD numHandles, const HANDLE *pHandles, Milliseconds timeout)
static bool	WaitWithMessageLoop (DWORD numHandles, const HANDLE *pHandles, DWORD &signalledHandle, Milliseconds timeout)
static bool	WaitWithMessageLoop (DWORD numHandles, const HANDLE *pHandles, DWORD &signalledHandle, Milliseconds timeout, DWORD removeFlags)

---

Member Enumeration Documentation

enum ResetType

Specify the type of event object.

Enumerator:

ManualReset
AutoReset

enum InitialState

Specify the initial state of an event object.

Enumerator:

Signaled
NonSignaled

---

Constructor & Destructor Documentation

CEvent	(	ResetType	resetType,
		InitialState	initialState
	)

CEvent

(

const CEvent &

rhs

)

---

Member Function Documentation

CEvent& operator=

(

const CEvent &

rhs

)

void Reset

(

)

Reset the event to the unsignalled state.

void Set

(

)

Set the event to the signalled state.

HANDLE GetWaitHandle

(

)

const [override, virtual]

Access a HANDLE to wait on by passing it to one of the Wait Functions.

Implements IWaitable.

void Wait

(

)

const [override, virtual]

Wait indefinitely for the object to become signalled.

Implements IWaitable.

bool Wait

(

Milliseconds

timeout

)

const [override, virtual]

Wait, with a time limit, for the object to become signalled. If you want to wait for 0 milliseconds and you get an "ambiguous call" with the Handle version then use IsSignalled() which is the same as Wait(0).

Implements IWaitable.

bool IsSignalled

(

)

const [virtual, inherited]

Returns true if the object is signalled and false if it isn't; doesn't block.

void WaitForHandle

(

HANDLE

handle

)

[static, inherited]

Wait indefinitely for the supplied handle to become signalled.

bool WaitForHandle	(	HANDLE	handle,
		Milliseconds	timeout
	)			[static, inherited]

Wait, with a time limit, for the supplied handle to become signalled.

DWORD WaitForMultipleHandles	(	DWORD	numHandles,
		HANDLE *	pHandles,
		bool	waitAll,
		Milliseconds	timeout
	)			[static, inherited]

bool WaitWithMessageLoop	(	HANDLE	handle,
		Milliseconds	timeout
	)			[static, inherited]

bool WaitWithMessageLoop	(	HANDLE	handle,
		Milliseconds	timeout,
		DWORD	removeFlags
	)			[static, inherited]

bool WaitWithMessageLoop	(	DWORD	numHandles,
		const HANDLE *	pHandles,
		Milliseconds	timeout
	)			[static, inherited]

bool WaitWithMessageLoop	(	DWORD	numHandles,
		const HANDLE *	pHandles,
		DWORD &	signalledHandle,
		Milliseconds	timeout
	)			[static, inherited]

bool WaitWithMessageLoop	(	DWORD	numHandles,
		const HANDLE *	pHandles,
		DWORD &	signalledHandle,
		Milliseconds	timeout,
		DWORD	removeFlags
	)			[static, inherited]

---