cosmos::Mutex Class Reference

A class to represent a pthread mutex. More...

#include <Mutex.hxx>

Inheritance diagram for cosmos::Mutex:

Public Member Functions
	Mutex ()
	Create a non-recursive Mutex.
void	lock () const
void	unlock () const

Protected Attributes
pthread_mutex_t	m_pmutex

Friends
class	Condition

Detailed Description

A class to represent a pthread mutex.

Only the most basic operations are implemented by now. For more details about the semantics refer to man pthread_mutex_init and man pthread_mutex_destroy.

Definition at line 25 of file Mutex.hxx.

Constructor & Destructor Documentation

Mutex()

cosmos::Mutex::Mutex

(

)

Create a non-recursive Mutex.

Other mutex types are not currently provided.

If the NDEBUG define is not set (during libcosmos build) then additional error checks are in effect that allow detection of deadlocks etc.

Definition at line 64 of file Mutex.cxx.

             {
        auto res = ::pthread_mutex_init(&m_pmutex, g_attr.getAttr());
        if (auto err = Errno{res}; err != Errno::NO_ERROR) {
                cosmos_throw (ApiError("pthread_mutex_init()", err));
        }
}

~Mutex()

cosmos::Mutex::~Mutex ( )

inline

Definition at line 42 of file Mutex.hxx.

                 {
                const auto destroy_res = ::pthread_mutex_destroy(&m_pmutex);
 
                assert (!destroy_res);
                (void)destroy_res;
        }

Member Function Documentation

lock()

void cosmos::Mutex::lock ( ) const

inline

Definition at line 49 of file Mutex.hxx.

                          {
                const auto lock_res = ::pthread_mutex_lock(&m_pmutex);
 
                if (lock_res) {
                        cosmos_throw (ApiError("pthread_mutex_lock()", Errno{lock_res}));
                }
        }

unlock()

void cosmos::Mutex::unlock ( ) const

inline

Definition at line 57 of file Mutex.hxx.

                            {
                const int unlock_res = ::pthread_mutex_unlock(&m_pmutex);
 
                if (unlock_res) {
                        cosmos_throw (ApiError("pthread_mutex_unlock()", Errno{unlock_res}));
                }
        }

Friends And Related Symbol Documentation

Condition

friend class Condition

friend

Definition at line 71 of file Mutex.hxx.

Member Data Documentation

m_pmutex

pthread_mutex_t cosmos::Mutex::m_pmutex

mutableprotected

Definition at line 68 of file Mutex.hxx.

---

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

• include/thread/Mutex.hxx
• src/thread/Mutex.cxx