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

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

Search

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

Inheritance diagram for CAutoResetEvent:

[legend]

Collaboration diagram for CAutoResetEvent:

[legend]

List of all members.

---

Detailed Description

A class that wraps the operating system Event API and exposes just the interface for an auto reset event.

Public Member Functions
	CAutoResetEvent (CEvent::InitialState initialState=CEvent::NonSignaled, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr)
	Create an anonymous CAutoResetEvent object for in-process use.
	CAutoResetEvent (const IKernelObjectName &name, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr, CEvent::InitialState initialState=CEvent::NonSignaled)
	Create a new named CAutoResetEvent object or connect to an existing one with the same name, for cross-process use.
	CAutoResetEvent (const IKernelObjectName &name, CEvent::CreationFlags creationFlags, SECURITY_ATTRIBUTES *pSecurityAttributes=nullptr, CEvent::InitialState initialState=CEvent::NonSignaled)
	Create a new named CAutoResetEvent object or connect to an existing one with the same name, for cross-process use. Use the CreationFlags to force creation only or connection only if required.
	CAutoResetEvent (const CAutoResetEvent &rhs)
CAutoResetEvent &	operator= (const CAutoResetEvent &rhs)
void	Set ()
	Set the event to the signalled state.
void	Pulse ()
	Pulse the event. Releases one waiting thread and resets the event.
HANDLE	GetWaitHandle () const override
void	Wait () const override
bool	Wait (Milliseconds timeout) const override

---

Constructor & Destructor Documentation

CAutoResetEvent	(	CEvent::InitialState	initialState = CEvent::NonSignaled,
		SECURITY_ATTRIBUTES *	pSecurityAttributes = nullptr
	)			[explicit]

Create an anonymous CAutoResetEvent object for in-process use.

CAutoResetEvent	(	const IKernelObjectName &	name,
		SECURITY_ATTRIBUTES *	pSecurityAttributes = nullptr,
		CEvent::InitialState	initialState = CEvent::NonSignaled
	)			[explicit]

Create a new named CAutoResetEvent object or connect to an existing one with the same name, for cross-process use.

CAutoResetEvent	(	const IKernelObjectName &	name,
		CEvent::CreationFlags	creationFlags,
		SECURITY_ATTRIBUTES *	pSecurityAttributes = nullptr,
		CEvent::InitialState	initialState = CEvent::NonSignaled
	)

Create a new named CAutoResetEvent object or connect to an existing one with the same name, for cross-process use. Use the CreationFlags to force creation only or connection only if required.

CAutoResetEvent

(

const CAutoResetEvent &

rhs

)

---

Member Function Documentation

CAutoResetEvent& operator=

(

const CAutoResetEvent &

rhs

)

void Set

(

)

Set the event to the signalled state.

void Pulse

(

)

Pulse the event. Releases one waiting thread and resets the event.

HANDLE GetWaitHandle

(

)

const [override]

void Wait

(

)

const [override]

bool Wait

(

Milliseconds

timeout

)

const [override]

---