blocxx
Public Member Functions | Private Attributes | Friends | List of all members
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 82 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 118 of file NonRecursiveMutexLock.hpp.

◆ ~NonRecursiveMutexLock()

BLOCXX_NAMESPACE::NonRecursiveMutexLock::~NonRecursiveMutexLock ( )
inline

Definition at line 126 of file NonRecursiveMutexLock.hpp.

◆ NonRecursiveMutexLock() [2/2]

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

Definition at line 163 of file NonRecursiveMutexLock.hpp.

Member Function Documentation

◆ isLocked()

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

Definition at line 171 of file NonRecursiveMutexLock.hpp.

◆ lock()

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

Definition at line 144 of file NonRecursiveMutexLock.hpp.

◆ release()

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

Definition at line 154 of file NonRecursiveMutexLock.hpp.

Friends And Related Function Documentation

◆ Condition

friend class Condition
friend

Definition at line 188 of file NonRecursiveMutexLock.hpp.

Member Data Documentation

◆ m_locked

bool BLOCXX_NAMESPACE::NonRecursiveMutexLock::m_locked
mutableprivate

Definition at line 187 of file NonRecursiveMutexLock.hpp.

◆ m_mutex

NonRecursiveMutex* BLOCXX_NAMESPACE::NonRecursiveMutexLock::m_mutex
private

Definition at line 186 of file NonRecursiveMutexLock.hpp.


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