OpenThreads
Public Member Functions | Friends
OpenThreads::Mutex Class Reference

This class provides an object-oriented thread mutex interface. More...

Inheritance diagram for OpenThreads::Mutex:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Mutex ()
 Constructor.
virtual ~Mutex ()
 Destructor.
virtual int lock ()
 Lock the mutex.
virtual int unlock ()
 Unlock the mutex.
virtual int trylock ()
 Test if mutex can be locked.

Friends

class Condition

Detailed Description

This class provides an object-oriented thread mutex interface.


Constructor & Destructor Documentation

OpenThreads::Mutex::Mutex ( )

Constructor.

virtual OpenThreads::Mutex::~Mutex ( ) [virtual]

Destructor.


Member Function Documentation

virtual int OpenThreads::Mutex::lock ( ) [virtual]

Lock the mutex.

Returns:
0 if normal, -1 if errno set, errno code otherwise.

Reimplemented in OpenThreads::ReentrantMutex.

Referenced by OpenThreads::ReadWriteMutex::readLock(), and OpenThreads::ReadWriteMutex::writeLock().

virtual int OpenThreads::Mutex::trylock ( ) [virtual]

Test if mutex can be locked.

Returns:
0 if normal, -1 if errno set, errno code otherwise.

Reimplemented in OpenThreads::ReentrantMutex.

virtual int OpenThreads::Mutex::unlock ( ) [virtual]

Unlock the mutex.

Returns:
0 if normal, -1 if errno set, errno code otherwise.

Reimplemented in OpenThreads::ReentrantMutex.

Referenced by OpenThreads::ReadWriteMutex::readUnlock(), and OpenThreads::ReadWriteMutex::writeUnlock().


Friends And Related Function Documentation

friend class Condition [friend]

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

osg logo
Generated at Sun Jan 8 2012 13:22:10 for the OpenThreads by doxygen 1.7.4.