original::mutex Class Reference

Inheritance diagram for original::mutex:

Collaboration diagram for original::mutex:

Public Types
using	native_handle = mutex()

Public Member Functions
	mutex (mutex &&)=delete
mutex &	operator= (mutex &)=delete
ul_integer	id () const override
	Gets a unique identifier for the mutex.
void *	nativeHandle () noexcept override
	Gets the native handle of the mutex.
void	lock () override
	Locks the mutex, blocking if necessary.
bool	tryLock () override
	Attempts to lock the mutex without blocking.
void	unlock () override
	Unlocks the mutex.
Public Member Functions inherited from original::mutexBase
	mutexBase ()=default
	Default constructor.
	mutexBase (const mutexBase &)=delete
	Deleted copy constructor.
mutexBase &	operator= (const mutexBase &)=delete
	Deleted copy assignment operator.
virtual	~mutexBase ()=default
	Virtual destructor.

Member Function Documentation

id()

original::ul_integer original::mutex::id ( ) const

inlineoverridevirtual

Gets a unique identifier for the mutex.

Returns

Unique identifier based on mutex internal state

Implements original::mutexBase.

lock()

void original::mutex::lock ( )

inlineoverridevirtual

Locks the mutex, blocking if necessary.

Exceptions

sysError

if the lock operation fails

Implements original::mutexBase.

nativeHandle()

void * original::mutex::nativeHandle ( )

inlineoverridevirtualnoexcept

Gets the native handle of the mutex.

Returns

Pointer to the native mutex handle

Implements original::mutexBase.

tryLock()

bool original::mutex::tryLock ( )

inlineoverridevirtual

Attempts to lock the mutex without blocking.

Returns

true if lock was acquired, false otherwise

Exceptions

sysError

if the operation fails (other than EBUSY)

Implements original::mutexBase.

unlock()

void original::mutex::unlock ( )

inlineoverridevirtual

Unlocks the mutex.

Exceptions

sysError

if the unlock operation fails

Implements original::mutexBase.

---

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

• src/vibrant/mutex.h