CWin32Event Class Reference

#include <Win32Event.h>

Inheritance diagram for CWin32Event:

[legend]

Collaboration diagram for CWin32Event:

[legend]

List of all members.

Public Member Functions
void	PopulateOverlapped (OVERLAPPED &rOverlapped)
virtual void	ReleaseObject ()
virtual void	Pulse ()
virtual void	Set ()
virtual void	Reset ()
virtual BOOL	Wait (unsigned long ulMSTimeout=INFINITE)
	CWin32Event (BOOL bInitialState=FALSE, BOOL bManualReset=FALSE, const char *pEventName=NULL, LPVOID lpSecurity=NULL)
virtual	~CWin32Event ()
virtual BOOL	IsFirst () const
Protected Member Functions
virtual HANDLE	GetHandle () const
	CWin32Event (BOOL bInitialState, BOOL bManualReset, const char *pEventName, bool bLater)
void	SetHandle (HANDLE hEvent)
void	SetFirst ()

---

Detailed Description

Definition at line 47 of file Win32Event.h.

---

Constructor & Destructor Documentation

KOMODIA_NAMESPACE_START CWin32Event::CWin32Event	(	BOOL	bInitialState = FALSE,
		BOOL	bManualReset = FALSE,
		const char *	pEventName = NULL,
		LPVOID	lpSecurity = NULL
	)

Definition at line 49 of file Win32Event.cpp.

                                            : CGenericEvent(bInitialState,
                                                            bManualReset,
                                                            pEventName),
                                              m_hEvent(NULL)
{
    //Create the event
    m_hEvent=CreateEvent((LPSECURITY_ATTRIBUTES)lpSecurity,
                         bManualReset,
                         bInitialState,
                         pEventName);

    //Do we have the event
    if (!m_hEvent)
        throw std::string("Failed to create event!");

    //Check if we are the owners
    if (pEventName && 
        GetLastError()!=ERROR_ALREADY_EXISTS)
        SetFirst();
}

CWin32Event::~CWin32Event

(

)

[virtual]

Definition at line 83 of file Win32Event.cpp.

{
    if (m_hEvent)
        CloseHandle(m_hEvent);
}

CWin32Event::CWin32Event	(	BOOL	bInitialState,
		BOOL	bManualReset,
		const char *	pEventName,
		bool	bLater
	)			[protected]

Definition at line 73 of file Win32Event.cpp.

                                     : CGenericEvent(bInitialState,
                                                     bManualReset,
                                                     pEventName),
                                       m_hEvent(NULL)
{
}

---

Member Function Documentation

HANDLE CWin32Event::GetHandle

(

)

const [protected, virtual]

Implements CWaitableObject.

Definition at line 112 of file Win32Event.cpp.

{
    return m_hEvent;
}

BOOL CWaitableObject::IsFirst

(

)

const [virtual, inherited]

Definition at line 54 of file WaitableObject.cpp.

{
    return m_bFirst;
}

void CWin32Event::PopulateOverlapped

(

OVERLAPPED &

rOverlapped

)

Definition at line 134 of file Win32Event.cpp.

{
    rOverlapped.hEvent=m_hEvent;
}

void CWin32Event::Pulse

(

)

[virtual]

Implements CGenericEvent.

Definition at line 123 of file Win32Event.cpp.

{
    if (m_hEvent)
        PulseEvent(m_hEvent);
}

void CWin32Event::ReleaseObject

(

)

[virtual]

Implements CWaitableObject.

Definition at line 129 of file Win32Event.cpp.

{
    Reset();
}

void CWin32Event::Reset

(

)

[virtual]

Implements CGenericEvent.

Definition at line 117 of file Win32Event.cpp.

{
    if (m_hEvent)
        ResetEvent(m_hEvent);
}

void CWin32Event::Set

(

)

[virtual]

Implements CGenericEvent.

Definition at line 94 of file Win32Event.cpp.

{
    if (m_hEvent)
        SetEvent(m_hEvent);
}

void CWaitableObject::SetFirst

(

)

[protected, inherited]

Definition at line 49 of file WaitableObject.cpp.

{
    m_bFirst=TRUE;
}

void CWin32Event::SetHandle

(

HANDLE

hEvent

)

[protected]

Definition at line 89 of file Win32Event.cpp.

{
    m_hEvent=hEvent;
}

BOOL CWin32Event::Wait

(

unsigned long

ulMSTimeout = INFINITE

)

[virtual]

Implements CGenericEvent.

Definition at line 100 of file Win32Event.cpp.

{
    DWORD dwWaitResult;

    //Wait for the mutex
    dwWaitResult=WaitForSingleObject(m_hEvent,
                                     ulMSTimeout);

    //Check why did we quit
    return dwWaitResult==WAIT_TIMEOUT;
}

---

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

• Win32Event.h
• Win32Event.cpp