OpenSceneGraph
Public Member Functions | List of all members
OpenThreads::Condition Class Reference

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

Public Member Functions

 Condition ()
 Constructor. More...
 
virtual ~Condition ()
 Destructor. More...
 
virtual int wait (Mutex *mutex)
 Wait on a mutex. More...
 
virtual int wait (Mutex *mutex, unsigned long int ms)
 Wait on a mutex for a given amount of time (ms) More...
 
virtual int signal ()
 Signal a SINGLE thread to wake if it's waiting. More...
 
virtual int broadcast ()
 Wake all threads waiting on this condition. More...
 

Detailed Description

This class provides an object-oriented thread condition interface.

Constructor & Destructor Documentation

◆ Condition()

OpenThreads::Condition::Condition ( )

Constructor.

◆ ~Condition()

virtual OpenThreads::Condition::~Condition ( )
virtual

Destructor.

Member Function Documentation

◆ broadcast()

virtual int OpenThreads::Condition::broadcast ( )
virtual

Wake all threads waiting on this condition.

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

Referenced by OpenThreads::BlockCount::completed(), OpenThreads::Block::release(), OpenThreads::BlockCount::release(), and OpenThreads::BlockCount::reset().

◆ signal()

virtual int OpenThreads::Condition::signal ( )
virtual

Signal a SINGLE thread to wake if it's waiting.

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

◆ wait() [1/2]

virtual int OpenThreads::Condition::wait ( Mutex mutex)
virtual

Wait on a mutex.

Referenced by OpenThreads::Block::block(), and OpenThreads::BlockCount::block().

◆ wait() [2/2]

virtual int OpenThreads::Condition::wait ( Mutex mutex,
unsigned long int  ms 
)
virtual

Wait on a mutex for a given amount of time (ms)

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

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