Os::Mutex Class Reference

#include <Os/Mutex.hpp>

Public Member Functions
	Mutex ()
	Constructor. Mutex is unlocked when created.
virtual	~Mutex ()
	Destructor.
void	lock ()
	lock the mutex
void	unLock ()
	unlock the mutex
void	unlock ()
	alias for unLock to meet BasicLockable requirements

Detailed Description

Definition at line 8 of file Mutex.hpp.

Constructor & Destructor Documentation

Mutex()

Os::Mutex::Mutex

(

)

Constructor. Mutex is unlocked when created.

On baremetal, mutexes are not required as there is a single threaded engine to run on.

Definition at line 7 of file Mutex.cpp.

~Mutex()

Os::Mutex::~Mutex ( )

virtual

Destructor.

Definition at line 11 of file Mutex.cpp.

Member Function Documentation

lock()

void Os::Mutex::lock

(

)

lock the mutex

Definition at line 12 of file Mutex.cpp.

unLock()

void Os::Mutex::unLock

(

)

unlock the mutex

Definition at line 13 of file Mutex.cpp.

unlock()

void Os::Mutex::unlock ( )

inline

alias for unLock to meet BasicLockable requirements

Definition at line 16 of file Mutex.hpp.

---

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

• Os/Mutex.hpp
• Os/Baremetal/Mutex.cpp
• Os/Posix/Mutex.cpp