Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Examples  

ost::MutexLock Class Reference

The MutexLock class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. Mutex automatic locker for protected access. More...

#include <thread.h>

List of all members.

Public Methods

 MutexLock (Mutex &_mutex)
 Acquire the mutex. More...

 ~MutexLock ()
 Release the mutex automatically. More...


Detailed Description

The MutexLock class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. Mutex automatic locker for protected access.

It use Mutex to protect operation. Using this class is usefull and exception safe. The mutex that has been locked is automatically released when the function call stack falls out of scope, so one doesnt have to remember to unlock the mutex at each function return.

A common use is

void func_to_protect() { MutexLock lock(mutex); ... operation ... }

NOTE: do not declare variable as "MutexLock (mutex)", the mutex will be released at statement end.

Author:
Frediano Ziglio <freddy77@angelfire.com>


Constructor & Destructor Documentation

ost::MutexLock::MutexLock ( Mutex & _mutex ) [inline]
 

Acquire the mutex.

Parameters:
_mutex   reference to mutex to aquire.

ost::MutexLock::~MutexLock ( ) [inline]
 

Release the mutex automatically.


The documentation for this class was generated from the following file:
Generated at Fri May 30 14:51:03 2008 for GNU CommonC++ by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001