blocxx
BLOCXX_NAMESPACE::NonRecursiveMutexLock Class Reference

Note that descriptions of what exceptions may be thrown assumes that object is used correctly, i.e., method preconditions are satisfied. More...

#include <NonRecursiveMutexLock.hpp>

Public Member Functions

 NonRecursiveMutexLock (NonRecursiveMutex &mutex, bool initially_locked=true)
 
 ~NonRecursiveMutexLock ()
 
void lock ()
 
void release ()
 
 NonRecursiveMutexLock (const NonRecursiveMutexLock &arg)
 
bool isLocked () const
 

Private Attributes

NonRecursiveMutexm_mutex
 
bool m_locked
 

Friends

class Condition
 

Detailed Description

Note that descriptions of what exceptions may be thrown assumes that object is used correctly, i.e., method preconditions are satisfied.

Definition at line 52 of file NonRecursiveMutexLock.hpp.

Constructor & Destructor Documentation

◆ NonRecursiveMutexLock() [1/2]

BLOCXX_NAMESPACE::NonRecursiveMutexLock::NonRecursiveMutexLock ( NonRecursiveMutex & mutex,
bool initially_locked = true )
inlineexplicit
Exceptions
noexception

Definition at line 58 of file NonRecursiveMutexLock.hpp.

◆ ~NonRecursiveMutexLock()

BLOCXX_NAMESPACE::NonRecursiveMutexLock::~NonRecursiveMutexLock ( )
inline

Definition at line 66 of file NonRecursiveMutexLock.hpp.

◆ NonRecursiveMutexLock() [2/2]

BLOCXX_NAMESPACE::NonRecursiveMutexLock::NonRecursiveMutexLock ( const NonRecursiveMutexLock & arg)
inline
Exceptions
noexception

Definition at line 103 of file NonRecursiveMutexLock.hpp.

References m_locked.

Member Function Documentation

◆ isLocked()

bool BLOCXX_NAMESPACE::NonRecursiveMutexLock::isLocked ( ) const
inline
Exceptions
noexception

Definition at line 111 of file NonRecursiveMutexLock.hpp.

Referenced by BLOCXX_NAMESPACE::Condition::timedWait(), and BLOCXX_NAMESPACE::Condition::wait().

◆ lock()

void BLOCXX_NAMESPACE::NonRecursiveMutexLock::lock ( )
inline
Precondition
Mutex not already locked by this thread.
Exceptions
noexception

Definition at line 84 of file NonRecursiveMutexLock.hpp.

References m_mutex.

◆ release()

void BLOCXX_NAMESPACE::NonRecursiveMutexLock::release ( )
inline
Precondition
Mutex currently locked by this thread and object.
Exceptions
noexception

Definition at line 94 of file NonRecursiveMutexLock.hpp.

References m_mutex.

Referenced by BLOCXX_NAMESPACE::UUID::UUID().

Friends And Related Symbol Documentation

◆ Condition

friend class Condition
friend

Definition at line 128 of file NonRecursiveMutexLock.hpp.

Member Data Documentation

◆ m_locked

bool BLOCXX_NAMESPACE::NonRecursiveMutexLock::m_locked
mutableprivate

Definition at line 127 of file NonRecursiveMutexLock.hpp.

Referenced by NonRecursiveMutexLock().

◆ m_mutex

NonRecursiveMutex* BLOCXX_NAMESPACE::NonRecursiveMutexLock::m_mutex
private

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