MMutexLock Class Reference

#include <MMutexLock.h>

Class Description

Methods for managing locks on threads created with MThreadPool and MThreadAsync.

Mutex lock class to be used with threads created by MThreadPool and MThreadAsync.

Examples:

Public Member Functions
	MMutexLock ()
	Create new mutex object. More...
	~MMutexLock ()
	Calling the destructor on a locked mutex does not unlock the mutex. More...
void	lock ()
	Create a lock. More...
void	unlock ()
	Release the current lock on a mutex.
bool	tryLock ()
	Attempt to lock the mutex. More...

Constructor & Destructor Documentation

MMutexLock

(

)

Create new mutex object.

The object is created unlocked.

~MMutexLock

(

)

Calling the destructor on a locked mutex does not unlock the mutex.

That must be done by calling unlock() before calling the destructor.

Member Function Documentation

void lock

(

)

Create a lock.

If the mutex is available it is locked immediately. If it is already locked by another thread, this function waits until the other thread has unlocked it, then creates the lock.

Examples:

bool tryLock

(

)

Attempt to lock the mutex.

If the mutex is already locked by another thread, the function returns right away.

Returns

• true lock was obtained
• false lock was not obtained

---

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

• MMutexLock.h
• MMutexLock.cpp