basis::mutex Class Reference

#include <mutex.h>

Inheritance diagram for basis::mutex:
Inheritance graph
[legend]
Collaboration diagram for basis::mutex:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 mutex ()
 Constructs a new mutex.
virtual ~mutex ()
 Destroys the mutex. It should not be locked upon destruction.
void construct ()
 Constructor for use with malloc/free instead of new/delete.
void destruct ()
 Destructor for use with malloc/free instead of new/delete.
void lock ()
 Clamps down on the mutex, if possible.
void unlock ()
 Gives up the possession of the mutex.
virtual void establish_lock ()
 Satisfies base class requirements for locking.
virtual void repeal_lock ()
 Satisfies base class requirements for unlocking.

Detailed Description

Definition at line 32 of file mutex.h.


Constructor & Destructor Documentation

basis::mutex::mutex (  ) 

Constructs a new mutex.

Definition at line 33 of file mutex.cpp.

References construct().

basis::mutex::~mutex (  )  [virtual]

Destroys the mutex. It should not be locked upon destruction.

Definition at line 35 of file mutex.cpp.

References destruct().


Member Function Documentation

void basis::mutex::construct (  ) 

Constructor for use with malloc/free instead of new/delete.

Definition at line 41 of file mutex.cpp.

Referenced by mutex().

void basis::mutex::destruct (  ) 

Destructor for use with malloc/free instead of new/delete.

Definition at line 66 of file mutex.cpp.

Referenced by ~mutex().

void basis::mutex::establish_lock (  )  [virtual]

Satisfies base class requirements for locking.

Implements basis::base_synchronizer.

Definition at line 37 of file mutex.cpp.

References lock().

void basis::mutex::lock (  ) 
void basis::mutex::repeal_lock (  )  [virtual]

Satisfies base class requirements for unlocking.

Implements basis::base_synchronizer.

Definition at line 39 of file mutex.cpp.

References unlock().

void basis::mutex::unlock (  ) 

The documentation for this class was generated from the following files:
Generated on Sat Jan 28 04:25:26 2012 for hoople2 project by  doxygen 1.6.3