PlatformMutex Class Reference

#include <PlatformMutex.h>

Public Member Functions
	PlatformMutex () noexcept
	~PlatformMutex () noexcept
	PlatformMutex (const PlatformMutex &)=delete
PlatformMutex &	operator= (const PlatformMutex &)=delete
	PlatformMutex (PlatformMutex &&other) noexcept
PlatformMutex &	operator= (PlatformMutex &&other) noexcept
bool	lock () noexcept
bool	try_lock () noexcept
bool	try_lock_for (uint32_t timeout_ms) noexcept
void	unlock () noexcept
SemaphoreHandle_t	native_handle () const noexcept
bool	Take (uint32_t timeout_ms=0) noexcept
void	Give () noexcept
bool	lock_shared () noexcept
bool	try_lock_shared () noexcept
bool	try_lock_shared_for (uint32_t timeout_ms) noexcept
void	unlock_shared () noexcept

Private Attributes
SemaphoreHandle_t	handle_

Constructor & Destructor Documentation

PlatformMutex() [1/3]

PlatformMutex::PlatformMutex ( )

inlinenoexcept

~PlatformMutex()

PlatformMutex::~PlatformMutex ( )

inlinenoexcept

PlatformMutex() [2/3]

PlatformMutex::PlatformMutex ( const PlatformMutex & )

delete

PlatformMutex() [3/3]

PlatformMutex::PlatformMutex ( PlatformMutex && other )

inlinenoexcept

Member Function Documentation

Give()

void PlatformMutex::Give ( )

inlinenoexcept

lock()

bool PlatformMutex::lock ( )

inlinenoexcept

lock_shared()

bool PlatformMutex::lock_shared ( )

inlinenoexcept

native_handle()

SemaphoreHandle_t PlatformMutex::native_handle ( ) const

inlinenoexcept

operator=() [1/2]

PlatformMutex & PlatformMutex::operator= ( const PlatformMutex & )

delete

operator=() [2/2]

PlatformMutex & PlatformMutex::operator= ( PlatformMutex && other )

inlinenoexcept

Take()

bool PlatformMutex::Take ( uint32_t timeout_ms = 0 )

inlinenoexcept

try_lock()

bool PlatformMutex::try_lock ( )

inlinenoexcept

try_lock_for()

bool PlatformMutex::try_lock_for ( uint32_t timeout_ms )

inlinenoexcept

try_lock_shared()

bool PlatformMutex::try_lock_shared ( )

inlinenoexcept

try_lock_shared_for()

bool PlatformMutex::try_lock_shared_for ( uint32_t timeout_ms )

inlinenoexcept

unlock()

void PlatformMutex::unlock ( )

inlinenoexcept

unlock_shared()

void PlatformMutex::unlock_shared ( )

inlinenoexcept

Member Data Documentation

handle_

SemaphoreHandle_t PlatformMutex::handle_

private

---

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

• inc/utils/PlatformMutex.h