Unigine::ScopedLock Class

This class implements a writer lock operating on a simple mutex.

Scoped locks work by locking a mutex when they are constructed, and unlocking it when they are destructed. The C++ rules guarantee that when the control flow leaves a scope (even via an exception), objects local to the scope being exited are destructed correctly. This means using a scoped lock instead of manually calling lock() and unlock() makes it impossible to accidentally not unlock the mutex, e.g. when an exception is thrown in the middle of the code between lock() and unlock().

Usage Example#

// declaring a mutex
Mutex shared_mutex_obj;

// ...

void do_something()
{
	// at this point in the ScopedLock constructor the mutex is locked, 
	// and a reference to it is kept in the 'lock' object for future use
	ScopedLock lock(shared_mutex_obj);

	//here goes the critical section code
	// ...

}//<-- at this point the 'lock' object goes out of scope
 // which means that the destructor of ScopedLock will run.
 // inside the destructor, the mutex is unlocked.