cosmos::RWLock Class Reference

This type represents a pthread read-write lock. More...

#include <RWLock.hxx>

Public Member Functions
void	readlock () const
void	writelock () const
void	unlock () const
	Unlock a previously obtained read or write lock.

Protected Attributes
pthread_rwlock_t	m_prwlock

Detailed Description

This type represents a pthread read-write lock.

A read-write lock can be locked in parallel for reading but only by one thread for writing at the same time. This is helpful if you got data that is updated rarely but read often.

Only the most basic operations are provided by now. For more information please refer to the POSIX man pages.

Definition at line 24 of file RWLock.hxx.

Constructor & Destructor Documentation

RWLock()

cosmos::RWLock::RWLock ( )

inline

Definition at line 30 of file RWLock.hxx.

                 {
                if (::pthread_rwlock_init( &m_prwlock, nullptr) != 0) {
                        cosmos_throw (ApiError("pthread_rwlock_init()"));
                }
        }

~RWLock()

cosmos::RWLock::~RWLock ( )

inline

Definition at line 36 of file RWLock.hxx.

                  {
                const auto destroy_res = ::pthread_rwlock_destroy(&m_prwlock);
 
                assert (!destroy_res);
                (void)destroy_res;
        }

Member Function Documentation

readlock()

void cosmos::RWLock::readlock ( ) const

inline

Definition at line 43 of file RWLock.hxx.

                              {
                if (::pthread_rwlock_rdlock(&m_prwlock) != 0) {
                        cosmos_throw (ApiError("pthread_rwlock_rdlock()"));
                }
        }

unlock()

void cosmos::RWLock::unlock ( ) const

inline

Unlock a previously obtained read or write lock.

Definition at line 56 of file RWLock.hxx.

                            {
                if (::pthread_rwlock_unlock(&m_prwlock) != 0) {
                        cosmos_throw (ApiError("pthread_rwlock_unlock()"));
                }
        }

writelock()

void cosmos::RWLock::writelock ( ) const

inline

Definition at line 49 of file RWLock.hxx.

                               {
                if (::pthread_rwlock_wrlock(&m_prwlock) != 0) {
                        cosmos_throw (ApiError("pthread_rwlock_wrlock()"));
                }
        }

Member Data Documentation

m_prwlock

pthread_rwlock_t cosmos::RWLock::m_prwlock

mutableprotected

Definition at line 65 of file RWLock.hxx.

---

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

• include/thread/RWLock.hxx