MutexLock Class Reference

#include <mutex.h>

Collaboration diagram for MutexLock:

[legend]List of all members.

---

Detailed Description

Simple class for automatic locking/unlocking mutex object Makes it easier to manage a mutex lock by automatic lock on creation and unlock on destruction. An example:.

 void foo()
 {
   MutexLock kLock( &kSomeMutex );

   //kSomeMutex is now locked
   if( someTestThatFails() )
     return;

   doSomething();

 } //The kSomeMutex is automatically unlocked whenever the function returns
   //since the kLock object is destroyed when it runs out of scope
 

Author:

Mattias Jansson (mattias@realityrift.com)

Public Member Functions
	MutexLock (MutexObject *pkMutexObject)
virtual	~MutexLock ()
Private Attributes
MutexObject *	m_pkMutexObject

---

Constructor & Destructor Documentation

MutexLock (  MutexObject *  pkMutexObject  )

Lock mutex object Parameters: pkMutexObject  Mutex object

virtual ~MutexLock (   )  [virtual]

Unlock mutex object

---

Member Data Documentation

MutexObject* m_pkMutexObject [private]

Mutex object we have locked

---

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

• mutex.h

---