CEvent Class Reference
[Win32 Synchronization primitives, Win32 Kernel Objects]

Inheritance diagram for CEvent:

[legend]

Collaboration diagram for CEvent:

[legend]

List of all members.

---

Detailed Description

A class that wraps the operating system Event API. See here for more details.

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 (SECURITY_ATTRIBUTES *pSecurityAttributes, ResetType resetType, InitialState initialState)
	Create an anonymous CEvent object for in-process use.
	CEvent (SECURITY_ATTRIBUTES *pSecurityAttributes, ResetType resetType, InitialState initialState, const IKernelObjectName &name)
	Create a named CEvent object for cross-process use.
void	Reset ()
	Reset the event to the unsignalled state.
void	Set ()
	Set the event to the signalled state.
void	Pulse ()
	Pulse the event.
HANDLE	GetWaitHandle () const
	Access a HANDLE to wait on by passing it to one of the Wait Functions.
void	Wait () const
	Wait indefinitely for the object to become signalled.
bool	Wait (const Milliseconds timeout) const
	Wait, with a time limit, for the object to become signalled.
Static Public Member Functions
static void	Wait (HANDLE handle)
	Wait indefinitely for the supplied handle to become signalled.
static bool	Wait (HANDLE handle, const Milliseconds timeout)
	Wait, with a time limit, for the supplied handle to become signalled.

---

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	(	SECURITY_ATTRIBUTES *	pSecurityAttributes,
		ResetType	resetType,
		InitialState	initialState
	)

Create an anonymous CEvent object for in-process use.

CEvent	(	SECURITY_ATTRIBUTES *	pSecurityAttributes,
		ResetType	resetType,
		InitialState	initialState,
		const IKernelObjectName &	name
	)

Create a named CEvent object for cross-process use.

---

Member Function Documentation

void Reset

(

)

Reset the event to the unsignalled state.

void Set

(

)

Set the event to the signalled state.

void Pulse

(

)

Pulse the event.

HANDLE GetWaitHandle

(

)

const [virtual]

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

Implements IWaitable.

void Wait

(

)

const [virtual]

Wait indefinitely for the object to become signalled.

Implements IWaitable.

bool Wait

(

const Milliseconds

timeout

)

const [virtual]

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

Implements IWaitable.

void Wait

(

HANDLE

handle

)

[static, inherited]

Wait indefinitely for the supplied handle to become signalled.

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

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

---