UCommon
ucommon::ConditionMutex Class Reference

Condition Mutex to pair with conditionals. More...

#include <condition.h>

Inheritance diagram for ucommon::ConditionMutex:

Public Member Functions

 ConditionMutex ()
 Initialize and construct conditional.
 
void lock (void)
 Lock the conditional's supporting mutex.
 
void unlock (void)
 Unlock the conditional's supporting mutex.
 
 ~ConditionMutex ()
 Destroy conditional, release any blocked threads.
 

Protected Attributes

pthread_mutex_t mutex
 

Friends

class autolock
 
class ConditionVar
 

Detailed Description

Condition Mutex to pair with conditionals.

Separating the mutex means we can apply it either paired with a condition variable, or shared among multiple condition variables.

Author
David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 61 of file condition.h.

Member Function Documentation

◆ lock()

void ucommon::ConditionMutex::lock ( void )
inline

Lock the conditional's supporting mutex.

Definition at line 100 of file condition.h.

◆ unlock()

void ucommon::ConditionMutex::unlock ( void )
inline

Unlock the conditional's supporting mutex.

Definition at line 107 of file condition.h.

Friends And Related Symbol Documentation

◆ autolock

friend class autolock
friend

Definition at line 65 of file condition.h.

◆ ConditionVar

friend class ConditionVar
friend

Definition at line 64 of file condition.h.

Field Documentation

◆ mutex

pthread_mutex_t ucommon::ConditionMutex::mutex
mutableprotected

Definition at line 73 of file condition.h.


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