riot::mutex Class Reference

C++11 compliant implementation of mutex, uses the time point implemented in our chrono replacement instead of the specified one. More...

Detailed Description

C++11 compliant implementation of mutex, uses the time point implemented in our chrono replacement instead of the specified one.

See also

std::mutex

Definition at line 43 of file mutex.hpp.

#include <mutex.hpp>

Public Types
using	native_handle_type = mutex_t *
	The native handle type used by the mutex.

Public Member Functions
void	lock ()
	Lock the mutex.
bool	try_lock () noexcept
	Try to lock the mutex.
void	unlock () noexcept
	Unlock the mutex.
native_handle_type	native_handle ()
	Provides access to the native handle.

Member Typedef Documentation

native_handle_type

using riot::mutex::native_handle_type = mutex_t*

The native handle type used by the mutex.

Definition at line 48 of file mutex.hpp.

Constructor & Destructor Documentation

mutex()

constexpr riot::mutex::mutex ( )

inlineconstexprnoexcept

Definition at line 50 of file mutex.hpp.

Member Function Documentation

native_handle()

native_handle_type riot::mutex::native_handle ( )

inline

Provides access to the native handle.

Returns

The native handle of the mutex.

Definition at line 71 of file mutex.hpp.

try_lock()

bool riot::mutex::try_lock ( )

noexcept

Try to lock the mutex.

Returns

true if the mutex was locked, false otherwise.

---

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

• sys/cpp11-compat/include/riot/mutex.hpp