MutexHandle Class Reference

#include <mutex.h>

Public Member Functions
	MutexHandle ()
	~MutexHandle ()
bool	lock (void *mutex, bool blocking=false)
void	unlock ()

Detailed Description

Helper for simplifying mutex locking code.

This class will automatically unlock a mutex that you've locked through it, saving you from managing a lot of complex exit cases. For instance:

MutexHandle handle;
handle.lock(myMutex);
 
if(error1)
  return; // Auto-unlocked by handle if we leave here - normally would
          // leave the mutex locked, causing much pain later.
 
handle.unlock();

Constructor & Destructor Documentation

MutexHandle()

MutexHandle ( )

inline

~MutexHandle()

~MutexHandle ( )

inline

Member Function Documentation

lock()

bool lock ( void *  mutex, bool  blocking = false  )

inline

unlock()

void unlock ( )

inline

---

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

• platform/threads/mutex.h