LOW_thread_mutex::mutexLock Class Reference

Locking class for a mutex. More...

#include <LOW_thread_mutex.h>

Collaboration diagram for LOW_thread_mutex::mutexLock:

[legend]List of all members.

Public Member Functions
	mutexLock (LOW_thread_mutex &inMutex)
	Obtain the lock.
	~mutexLock ()
	Release the lock.
Private Attributes
LOW_thread_mutex &	mutex
	Pointer to the mutex the lock is for.

---

Detailed Description

Locking class for a mutex.

The class is intended to be used in a "locking is creation" design pattern. On creation a lock is optained on the mutex, and on destruction the mutex is released.

Definition at line 73 of file LOW_thread_mutex.h.

---

Constructor & Destructor Documentation

LOW_thread_mutex::mutexLock::mutexLock (  LOW_thread_mutex &  inMutex  )  [inline]

Obtain the lock. Inlined for performance reasons. Parameters: inMutex  Pointer to the mutex the lock is for. Definition at line 79 of file LOW_thread_mutex.h. References LOW_thread_mutex::lock(), and mutex.

LOW_thread_mutex::mutexLock::~mutexLock (   )  [inline]

Release the lock. Inlined for performance reasons. Definition at line 88 of file LOW_thread_mutex.h. References mutex, and LOW_thread_mutex::unlock().

---

Member Data Documentation

LOW_thread_mutex& LOW_thread_mutex::mutexLock::mutex [private]

Pointer to the mutex the lock is for. Definition at line 94 of file LOW_thread_mutex.h. Referenced by mutexLock(), and ~mutexLock().

---

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

• LOW_thread_mutex.h

---