openscenegraph
Public Types | Public Member Functions | Friends | List of all members
OpenThreads::Mutex Class Reference

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

#include <Mutex>

Inheritance diagram for OpenThreads::Mutex:
OpenThreads::ReentrantMutex

Public Types

enum  MutexType { MUTEX_NORMAL , MUTEX_RECURSIVE }
 

Public Member Functions

 Mutex (MutexType type=MUTEX_NORMAL)
 
virtual ~Mutex ()
 
MutexType getMutexType () const
 
virtual int lock ()
 
virtual int unlock ()
 
virtual int trylock ()
 

Friends

class Condition
 

Detailed Description

This class provides an object-oriented thread mutex interface.

Member Enumeration Documentation

◆ MutexType

Enumerator
MUTEX_NORMAL 
MUTEX_RECURSIVE 

Constructor & Destructor Documentation

◆ Mutex()

OpenThreads::Mutex::Mutex ( MutexType  type = MUTEX_NORMAL)

Constructor

◆ ~Mutex()

virtual OpenThreads::Mutex::~Mutex ( )
virtual

Destructor

Member Function Documentation

◆ getMutexType()

MutexType OpenThreads::Mutex::getMutexType ( ) const
inline

◆ lock()

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

Lock the mutex

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

◆ trylock()

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

Test if mutex can be locked.

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

◆ unlock()

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

Unlock the mutex

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

Friends And Related Symbol Documentation

◆ Condition

friend class Condition
friend

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