xsens::Mutex Class Reference

A base mutex class. More...

#include <xsens_mutex.h>

Public Member Functions
bool	claimMutex ()
	Claims (locks) a mutex. More...
bool	isLocked () const volatile
	Mutex ()
	Mutex (Mutex &&)=delete
	Mutex (Mutex const &)=delete
Mutex &	operator= (Mutex &&)=delete
Mutex &	operator= (Mutex const &)=delete
bool	releaseMutex ()
	Releases (unlocks) a mutex. More...
bool	tryClaimMutex ()
	Tries to claim (lock) a mutex. More...
	~Mutex ()

Private Attributes
volatile std::atomic_int	m_lockCount
XsThreadId	m_lockedBy
CRITICAL_SECTION	m_mutex

Friends
class	Lock
class	WaitCondition

Detailed Description

A base mutex class.

Definition at line 132 of file xsens_mutex.h.

Constructor & Destructor Documentation

Mutex() [1/3]

xsens::Mutex::Mutex ( )

inline

Definition at line 146 of file xsens_mutex.h.

~Mutex()

xsens::Mutex::~Mutex ( )

inline

Definition at line 159 of file xsens_mutex.h.

Mutex() [2/3]

xsens::Mutex::Mutex ( Mutex const &  )

delete

Mutex() [3/3]

xsens::Mutex::Mutex ( Mutex &&  )

delete

Member Function Documentation

claimMutex()

bool xsens::Mutex::claimMutex ( )

inline

Claims (locks) a mutex.

Returns

True if successful

Definition at line 178 of file xsens_mutex.h.

isLocked()

bool xsens::Mutex::isLocked ( ) const volatile

inline

Returns

True if a mutex is locked

Definition at line 233 of file xsens_mutex.h.

operator=() [1/2]

Mutex& xsens::Mutex::operator= ( Mutex &&  )

delete

operator=() [2/2]

Mutex& xsens::Mutex::operator= ( Mutex const &  )

delete

releaseMutex()

bool xsens::Mutex::releaseMutex ( )

inline

Releases (unlocks) a mutex.

Returns

True if successful

Definition at line 193 of file xsens_mutex.h.

tryClaimMutex()

bool xsens::Mutex::tryClaimMutex ( )

inline

Tries to claim (lock) a mutex.

Returns

True if successful

Definition at line 208 of file xsens_mutex.h.

Friends And Related Function Documentation

Lock

friend class Lock

friend

Definition at line 143 of file xsens_mutex.h.

WaitCondition

friend class WaitCondition

friend

Definition at line 144 of file xsens_mutex.h.

Member Data Documentation

m_lockCount

volatile std::atomic_int xsens::Mutex::m_lockCount

private

Definition at line 142 of file xsens_mutex.h.

m_lockedBy

XsThreadId xsens::Mutex::m_lockedBy

private

Definition at line 141 of file xsens_mutex.h.

m_mutex

CRITICAL_SECTION xsens::Mutex::m_mutex

private

Definition at line 136 of file xsens_mutex.h.

---

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

• xsens_mutex.h