CWin32Semaphore Class Reference

#include <Win32Semaphore.h>

Inheritance diagram for CWin32Semaphore:

[legend]

Collaboration diagram for CWin32Semaphore:

[legend]

List of all members.

Public Member Functions
virtual void	ReleaseObject ()
virtual BOOL	Aquire (unsigned long ulMSTimeout=INFINITE)
virtual long	Release (long lAmount=1)
	CWin32Semaphore (long lInitialCount, long lMaxCount, const char *pSemaphoreName=NULL)
virtual	~CWin32Semaphore ()
virtual BOOL	IsFirst () const
Protected Member Functions
virtual HANDLE	GetHandle () const
	CWin32Semaphore (long lInitialCount, long lMaxCount, const char *pSemaphoreName, bool bLater)
void	SetHandle (HANDLE hSemaphore)
void	SetFirst ()

---

Detailed Description

Definition at line 47 of file Win32Semaphore.h.

---

Constructor & Destructor Documentation

KOMODIA_NAMESPACE_START CWin32Semaphore::CWin32Semaphore	(	long	lInitialCount,
		long	lMaxCount,
		const char *	pSemaphoreName = NULL
	)

Definition at line 49 of file Win32Semaphore.cpp.

                                                             : CGenericSemaphore(lInitialCount,
                                                                                 lMaxCount,
                                                                                 pSemaphoreName),
                                                               m_hSemaphore(0)
{
    //Create the semaphore
    m_hSemaphore=CreateSemaphore(NULL,
                                 lInitialCount,
                                 lMaxCount,
                                 pSemaphoreName);

    //Did we create the semaphore?
    if (!m_hSemaphore)
        throw std::string("Failed to create semaphore!");

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

CWin32Semaphore::~CWin32Semaphore

(

)

[virtual]

Definition at line 83 of file Win32Semaphore.cpp.

{
    if (m_hSemaphore)
        //Close the semaphore
        CloseHandle(m_hSemaphore);
}

CWin32Semaphore::CWin32Semaphore	(	long	lInitialCount,
		long	lMaxCount,
		const char *	pSemaphoreName,
		bool	bLater
	)			[protected]

Definition at line 72 of file Win32Semaphore.cpp.

                                              : CGenericSemaphore(lInitialCount,
                                                                  lMaxCount,
                                                                  pSemaphoreName),
                                                m_hSemaphore(NULL)

{
}

---

Member Function Documentation

BOOL CWin32Semaphore::Aquire

(

unsigned long

ulMSTimeout = INFINITE

)

[virtual]

Implements CGenericSemaphore.

Definition at line 95 of file Win32Semaphore.cpp.

{
    DWORD dwWaitResult;

    //Wait for the semaphore
    dwWaitResult=WaitForSingleObject(m_hSemaphore,
                                     ulMSTimeout);

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

HANDLE CWin32Semaphore::GetHandle

(

)

const [protected, virtual]

Implements CWaitableObject.

Definition at line 124 of file Win32Semaphore.cpp.

{
    return m_hSemaphore;
}

BOOL CWaitableObject::IsFirst

(

)

const [virtual, inherited]

Definition at line 54 of file WaitableObject.cpp.

{
    return m_bFirst;
}

long CWin32Semaphore::Release

(

long

lAmount = 1

)

[virtual]

Implements CGenericSemaphore.

Definition at line 107 of file Win32Semaphore.cpp.

{
    long lOld;
    BOOL bResult;

    //Release it
    bResult=ReleaseSemaphore(m_hSemaphore,
                             lAmount,
                             &lOld);

    //Check if it's an error
    if (bResult)
        return lOld;
    else
        return -1;
}

void CWin32Semaphore::ReleaseObject

(

)

[virtual]

Implements CWaitableObject.

Definition at line 129 of file Win32Semaphore.cpp.

{
    Release();
}

void CWaitableObject::SetFirst

(

)

[protected, inherited]

Definition at line 49 of file WaitableObject.cpp.

{
    m_bFirst=TRUE;
}

void CWin32Semaphore::SetHandle

(

HANDLE

hSemaphore

)

[protected]

Definition at line 90 of file Win32Semaphore.cpp.

{
    m_hSemaphore=hSemaphore;
}

---

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

• Win32Semaphore.h
• Win32Semaphore.cpp