ucc::mutex::mutex::gaurd Class Reference

Gaurd class to apply scope based mutex locking to objects. More...

#include <thread.h>


Public Member Functions

 gaurd ()
 Create an unitialized instance of gaurd.
 gaurd (void *object)
 Construct a gaurd for a specific object.
 ~gaurd ()
 Release mutex when gaurd falls out of scope.
void set (void *object)
 Set gaurd to mutex lock a new object.
void release (void)
 Prematurely release a gaurd.
void operator= (void *pointer)
 Set gaurd to mutex lock a new object.


Detailed Description

Gaurd class to apply scope based mutex locking to objects.

The mutex is located from the mutex pool rather than contained in the target object, and the lock is released when the gaurd object falls out of scope. This is essentially an automation mechanism for mutex::protect.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition at line 1092 of file thread.h.


Constructor & Destructor Documentation

ucc::mutex::mutex::gaurd::gaurd (  ) 

Create an unitialized instance of gaurd.

Usually used with a gaurd = operator.

ucc::mutex::mutex::gaurd::gaurd ( void *  object  ) 

Construct a gaurd for a specific object.

Parameters:
object to gaurd.


Member Function Documentation

void ucc::mutex::mutex::gaurd::operator= ( void *  pointer  )  [inline]

Set gaurd to mutex lock a new object.

If a lock is currently held, it is released.

Parameters:
pointer to object to gaurd.

Definition at line 1132 of file thread.h.

void ucc::mutex::mutex::gaurd::set ( void *  object  ) 

Set gaurd to mutex lock a new object.

If a lock is currently held, it is released.

Parameters:
object to gaurd.


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

Generated on Wed May 13 09:18:31 2009 for UCommon by  doxygen 1.5.8