RTT::os::Mutex Class Reference

An object oriented wrapper around a non recursive mutex. More...

#include <Mutex.hpp>

Inheritance diagram for RTT::os::Mutex:

Public Member Functions
virtual void	lock ()
	Mutex ()
virtual bool	timedlock (Seconds s)
virtual bool	trylock ()
virtual void	unlock ()
virtual	~Mutex ()
Public Member Functions inherited from RTT::os::MutexInterface
virtual void	lock_shared ()
virtual bool	timedlock_shared (Seconds)
virtual bool	trylock_shared ()
virtual void	unlock_shared ()
virtual	~MutexInterface ()

Protected Attributes
rt_mutex_t	m

Friends
class	Condition

Detailed Description

An object oriented wrapper around a non recursive mutex.

A mutex can only be unlock()'ed, by the thread which lock()'ed it. A trylock is a non blocking lock action which fails or succeeds.

Warning

Mutex instances should only be created in soft realtime, since the initialisation of a mutex can not be done in hard realtime.

See also

MutexLock, MutexTryLock, MutexTimedLock, MutexRecursive

Definition at line 92 of file Mutex.hpp.

Constructor & Destructor Documentation

RTT::os::Mutex::Mutex ( )

inline

Initialize a Mutex.

Definition at line 102 of file Mutex.hpp.

virtual RTT::os::Mutex::~Mutex ( )

inlinevirtual

Destroy a Mutex. If the Mutex is still locked, the RTOS will not be asked to clean up its resources.

Definition at line 112 of file Mutex.hpp.

Member Function Documentation

virtual void RTT::os::Mutex::lock ( )

inlinevirtual

Implements RTT::os::MutexInterface.

Definition at line 120 of file Mutex.hpp.

virtual bool RTT::os::Mutex::timedlock ( Seconds  s )

inlinevirtual

Lock this mutex, but don't wait longer for the lock than the specified timeout.

Parameters

s	The maximum time to wait before aqcuiring the lock.

Returns

true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 149 of file Mutex.hpp.

virtual bool RTT::os::Mutex::trylock ( )

inlinevirtual

Try to lock this mutex

Returns

true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 135 of file Mutex.hpp.

virtual void RTT::os::Mutex::unlock ( )

inlinevirtual

Implements RTT::os::MutexInterface.

Definition at line 125 of file Mutex.hpp.

Friends And Related Function Documentation

friend class Condition

friend

Definition at line 94 of file Mutex.hpp.

Member Data Documentation

rt_mutex_t RTT::os::Mutex::m

protected

Definition at line 97 of file Mutex.hpp.

---

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

• Mutex.hpp