ACE_Event_T< TIME_POLICY > Class Template Reference

A wrapper around the Win32 event locking mechanism. More...

#include <Event.h>

Inheritance diagram for ACE_Event_T< TIME_POLICY >:

Collaboration diagram for ACE_Event_T< TIME_POLICY >:

List of all members.

Public Member Functions
	ACE_Event_T (int manual_reset=0, int initial_state=0, int type=USYNC_THREAD, const ACE_TCHAR *name=0, void *arg=0, LPSECURITY_ATTRIBUTES sa=0)
	Constructor that creates event.
virtual	~ACE_Event_T (void)
	Implicitly destroy the event variable.
ACE_Time_Value_T< TIME_POLICY >	gettimeofday (void) const
void	set_time_policy (TIME_POLICY const &time_policy)
Public Member Functions inherited from ACE_Event_Base
virtual	~ACE_Event_Base (void)
	Implicitly destroy the event variable.
int	remove (void)
ACE_event_t	handle (void) const
	Underlying handle to event.
void	handle (ACE_event_t new_handle)
int	wait (void)
int	wait (const ACE_Time_Value *abstime, int use_absolute_time=1)
int	signal (void)
int	pulse (void)
int	reset (void)
	Set to nonsignaled state.
void	dump (void) const
	Dump the state of an object.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Public Attributes inherited from ACE_Event_Base

Protected Attributes
TIME_POLICY	time_policy_
	The policy to return the current time of day.
Protected Attributes inherited from ACE_Event_Base
ACE_event_t	handle_
	The underlying handle.
bool	removed_

Private Member Functions
	ACE_Event_T (const ACE_Event_T< TIME_POLICY > &event)
const ACE_Event_T &	operator= (const ACE_Event_T< TIME_POLICY > &rhs)

Additional Inherited Members
Protected Member Functions inherited from ACE_Event_Base
	ACE_Event_Base ()
	Only derived classes allowed to construct event.

---

Detailed Description

template<class TIME_POLICY = ACE_System_Time_Policy>
class ACE_Event_T< TIME_POLICY >

A wrapper around the Win32 event locking mechanism.

Portable implementation of an Event mechanism, which is native to Win32, but must be emulated on UNIX. All platforms support process-scope locking support. However, only Win32 platforms support global naming and system-scope locking support.

---

Constructor & Destructor Documentation

template<class TIME_POLICY >

ACE_Event_T< TIME_POLICY >::ACE_Event_T	(	int	manual_reset = 0,
		int	initial_state = 0,
		int	type = USYNC_THREAD,
		const ACE_TCHAR *	name = 0,
		void *	arg = 0,
		LPSECURITY_ATTRIBUTES	sa = 0
	)

Constructor that creates event.

template<class TIME_POLICY >

ACE_Event_T< TIME_POLICY >::~ACE_Event_T ( void  )

virtual

Implicitly destroy the event variable.

template<class TIME_POLICY = ACE_System_Time_Policy>

ACE_Event_T< TIME_POLICY >::ACE_Event_T ( const ACE_Event_T< TIME_POLICY > &  event )

private

---

Member Function Documentation

template<class TIME_POLICY >

ACE_Time_Value_T< TIME_POLICY > ACE_Event_T< TIME_POLICY >::gettimeofday

(

void

)

const

Get the current time of day according to the queue's TIME_POLICY. Allows users to initialize timeout values using correct time policy.

template<class TIME_POLICY = ACE_System_Time_Policy>

const ACE_Event_T& ACE_Event_T< TIME_POLICY >::operator= ( const ACE_Event_T< TIME_POLICY > &  rhs )

private

template<class TIME_POLICY>

void ACE_Event_T< TIME_POLICY >::set_time_policy

(

TIME_POLICY const &

time_policy

)

Allows applications to control how the event gets the time of day.

---

Member Data Documentation

template<class TIME_POLICY = ACE_System_Time_Policy>

ACE_Event_T< TIME_POLICY >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_Event_Base.

Reimplemented in ACE_Auto_Event_T< TIME_POLICY >, ACE_Manual_Event_T< TIME_POLICY >, ACE_Auto_Event_T< ACE_System_Time_Policy >, and ACE_Manual_Event_T< ACE_System_Time_Policy >.

template<class TIME_POLICY = ACE_System_Time_Policy>

TIME_POLICY ACE_Event_T< TIME_POLICY >::time_policy_

protected

The policy to return the current time of day.

---

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

• Event.h
• Event.cpp
• Event.inl