The Mutex class is used to synchronise the execution of threads. More...

#include <Mutex.h>

Public Member Functions
	Mutex ()
	Create and Initialize a Mutex object.
osStatus	lock (uint32_t millisec=osWaitForever)
	Wait until a Mutex becomes available.
bool	trylock ()
	Try to lock the mutex, and return immediately.
osStatus	unlock ()
	Unlock the mutex that has previously been locked by the same thread.

Detailed Description

The Mutex class is used to synchronise the execution of threads.

This is for example used to protect access to a shared resource.

Definition at line 33 of file Mutex.h.

Constructor & Destructor Documentation

Mutex ( )

Create and Initialize a Mutex object.

Definition at line 29 of file Mutex.cpp.

osStatus lock ( uint32_t millisec = osWaitForever )

Wait until a Mutex becomes available.

Parameters:

millisec timeout value or 0 in case of no time-out. (default: osWaitForever)

Definition at line 40 of file Mutex.cpp.

bool trylock ( )

Try to lock the mutex, and return immediately.

Definition at line 44 of file Mutex.cpp.

osStatus unlock ( void )

Unlock the mutex that has previously been locked by the same thread.

Definition at line 48 of file Mutex.cpp.