CLockMechanism Class Reference

Synchronization Base Object. More...

#include <LockMechanism.h>

Inherited by CMessagePool, CPacketQueue, CPeerList, and CResponseWaitQueue.

List of all members.

Public Member Functions

 CLockMechanism ()
 Constructor.
virtual ~CLockMechanism ()
 Destructor.
bool lock ()
 Lock the Object.
void unlock ()
 Unlock the Object.
void setTimeoutMsec (UINT32 timeout)
 set the timeout constant
UINT32 getTimeoutMsec ()
 read back the timeout constant

Protected Attributes

HANDLE m_hMutex
 platform handle; used to lock/unlock object
UINT32 m_uiTimeoutMsec


Detailed Description

Synchronization Base Object.

Implementation of a platform independent mutex object in order to synchronize multiple thread or multiple task access. Used inside ResponseWaitQueue, PacketQueue, MessageBuffers

The receiver will acknowlegde the command by calling Ack().

Definition at line 12 of file LockMechanism.h.


Constructor & Destructor Documentation

CLockMechanism::CLockMechanism (  ) 

Constructor.

Definition at line 15 of file LockMechanism.cpp.

CLockMechanism::~CLockMechanism (  )  [virtual]

Destructor.

Definition at line 24 of file LockMechanism.cpp.


Member Function Documentation

bool CLockMechanism::lock (  ) 

void CLockMechanism::unlock (  ) 

void CLockMechanism::setTimeoutMsec ( UINT32  timeout  ) 

set the timeout constant

Definition at line 30 of file LockMechanism.cpp.

UINT32 CLockMechanism::getTimeoutMsec (  ) 

read back the timeout constant

Definition at line 35 of file LockMechanism.cpp.


Member Data Documentation

HANDLE CLockMechanism::m_hMutex [protected]

platform handle; used to lock/unlock object

Definition at line 32 of file LockMechanism.h.

Referenced by CLockMechanism(), lock(), unlock(), and ~CLockMechanism().

UINT32 CLockMechanism::m_uiTimeoutMsec [protected]

Definition at line 33 of file LockMechanism.h.

Referenced by CLockMechanism(), getTimeoutMsec(), lock(), and setTimeoutMsec().


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

Generated on Wed Apr 16 18:22:16 2008 for NetworkQueue by  doxygen 1.5.5