threadschedule::PThreadMutex Class Reference

RAII wrapper for pthread_mutex_t. More...

#include <pthread_wrapper.hpp>

Public Member Functions
	PThreadMutex ()
	PThreadMutex (pthread_mutexattr_t const *attr)
	~PThreadMutex ()
	PThreadMutex (PThreadMutex const &)=delete
auto	operator= (PThreadMutex const &) -> PThreadMutex &=delete
void	lock ()
auto	try_lock () -> bool
void	unlock ()
auto	native_handle () -> pthread_mutex_t *

Detailed Description

RAII wrapper for pthread_mutex_t.

Non-copyable, non-movable. Satisfies the BasicLockable named requirement (lock / unlock / try_lock), so it can be used with std::lock_guard and similar RAII lock holders.

Note

The constructor throws std::runtime_error if pthread_mutex_init fails. Unusually for a mutex type, lock() and unlock() also throw on error - callers should be aware of this when mixing with code that assumes non-throwing mutex operations.

Definition at line 422 of file pthread_wrapper.hpp.

Constructor & Destructor Documentation

PThreadMutex() [1/3]

threadschedule::PThreadMutex::PThreadMutex ( )

inline

Definition at line 425 of file pthread_wrapper.hpp.

Referenced by operator=(), and PThreadMutex().

PThreadMutex() [2/3]

threadschedule::PThreadMutex::PThreadMutex ( pthread_mutexattr_t const * attr )

inlineexplicit

Definition at line 433 of file pthread_wrapper.hpp.

~PThreadMutex()

threadschedule::PThreadMutex::~PThreadMutex ( )

inline

Definition at line 441 of file pthread_wrapper.hpp.

PThreadMutex() [3/3]

threadschedule::PThreadMutex::PThreadMutex ( PThreadMutex const & )

delete

References PThreadMutex().

Member Function Documentation

lock()

void threadschedule::PThreadMutex::lock ( )

inline

Definition at line 449 of file pthread_wrapper.hpp.

native_handle()

auto threadschedule::PThreadMutex::native_handle ( ) -> pthread_mutex_t*

inline

Definition at line 470 of file pthread_wrapper.hpp.

operator=()

auto threadschedule::PThreadMutex::operator= ( PThreadMutex const & ) -> PThreadMutex &=delete

delete

References PThreadMutex().

try_lock()

auto threadschedule::PThreadMutex::try_lock ( ) -> bool

inline

Definition at line 457 of file pthread_wrapper.hpp.

unlock()

void threadschedule::PThreadMutex::unlock ( )

inline

Definition at line 462 of file pthread_wrapper.hpp.

---

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

• pthread_wrapper.hpp