event Class Reference
[Synchronisation Library]

#include <winstl/synch/event.hpp>

Inheritance diagram for event:

List of all members.

---

Detailed Description

Class which wraps the Win32 EVENT synchronisation object.

Public Types
typedef event	class_type
	This type.
typedef HANDLE	synch_handle_type
typedef HANDLE	resource_type
Public Member Functions
Construction
	event (bool bManualReset, bool bInitialState)
	Creates the event.
	event (char const *name, bool bManualReset, bool bInitialState)
	Creates the event with the given name.
	event (wchar_t const *name, bool bManualReset, bool bInitialState)
	Creates the event with the given name.
	event (char const *name, bool bManualReset, bool bInitialState, LPSECURITY_ATTRIBUTES psa)
	Creates the event with the given name and security attributes.
	event (wchar_t const *name, bool bManualReset, bool bInitialState, LPSECURITY_ATTRIBUTES psa)
	Creates the event with the given name and security attributes.
	~event () throw ()
	Destroys the event instance.
Operations
void	set ()
	Sets the state of the event to signalled.
void	reset ()
	Sets the state of the event to signalled.
Accessors
HANDLE	handle ()
	The underlying kernel object handle.
HANDLE	get ()
	The underlying kernel object handle.

---

Member Typedef Documentation

typedef event class_type

This type.

---

Constructor & Destructor Documentation

event	(	bool	bManualReset,
		bool	bInitialState
	)			[inline]

Creates the event.

event	(	char const *	name,
		bool	bManualReset,
		bool	bInitialState
	)			[inline, explicit]

Creates the event with the given name.

event	(	wchar_t const *	name,
		bool	bManualReset,
		bool	bInitialState
	)			[inline, explicit]

Creates the event with the given name.

event	(	char const *	name,
		bool	bManualReset,
		bool	bInitialState,
		LPSECURITY_ATTRIBUTES	psa
	)			[inline, explicit]

Creates the event with the given name and security attributes.

event	(	wchar_t const *	name,
		bool	bManualReset,
		bool	bInitialState,
		LPSECURITY_ATTRIBUTES	psa
	)			[inline, explicit]

Creates the event with the given name and security attributes.

~event

(

)

throw () [inline]

Destroys the event instance.

---

Member Function Documentation

void set

(

)

[inline]

Sets the state of the event to signalled.

References WINSTL_ASSERT.

void reset

(

)

[inline]

Sets the state of the event to signalled.

References WINSTL_ASSERT.

HANDLE handle

(

)

[inline]

The underlying kernel object handle.

HANDLE get

(

)

[inline]

The underlying kernel object handle.

Referenced by winstl::get_kernel_handle(), and winstl::get_synch_handle().

---

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

• winstl/synch/event.hpp