MutexLocker Class Reference

#include <mutex.h>

Public Member Functions
	MutexLocker (Mutex *const mutex)
	MutexLocker (const MutexLocker &m)
	~MutexLocker ()

Private Attributes
Mutex *	mMutex

Detailed Description

A convenience class for locking a mutex.

Definition at line 56 of file mutex.h.

Constructor & Destructor Documentation

MutexLocker() [1/2]

MutexLocker::MutexLocker ( Mutex *const  mutex )

inlineexplicit

Definition at line 98 of file mutex.h.

                                                  :
    mMutex(mutex)
{
    if (mMutex != nullptr)
        mMutex->lock();
}

References Mutex::lock(), and mMutex.

MutexLocker() [2/2]

MutexLocker::MutexLocker ( const MutexLocker &  m )

inline

Definition at line 61 of file mutex.h.

                                          :
            mMutex(m.mMutex)
        {
        }

~MutexLocker()

MutexLocker::~MutexLocker ( )

inline

Definition at line 105 of file mutex.h.

{
    if (mMutex != nullptr)
        mMutex->unlock();
}

References mMutex, and Mutex::unlock().

Field Documentation

mMutex

Mutex* MutexLocker::mMutex

private

Definition at line 71 of file mutex.h.

Referenced by MutexLocker(), and ~MutexLocker().

---

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

• src/utils/mutex.h (986a3bf)