RTT::os::Mutex Class Reference

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

#include <Mutex.hpp>

Inheritance diagram for RTT::os::Mutex:

[legend]

List of all members.

Public Member Functions
virtual void	lock ()
virtual void	lock ()
	Mutex ()
	Mutex ()
virtual bool	timedlock (Seconds s)
virtual bool	timedlock (Seconds s)
virtual bool	trylock ()
virtual bool	trylock ()
virtual void	unlock ()
virtual void	unlock ()
virtual	~Mutex ()
virtual	~Mutex ()
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 82 of file install/include/rtt/os/Mutex.hpp.

---

Constructor & Destructor Documentation

RTT::os::Mutex::Mutex

(

)

[inline]

Initialize a Mutex.

Definition at line 92 of file install/include/rtt/os/Mutex.hpp.

virtual RTT::os::Mutex::~Mutex

(

)

[inline, virtual]

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

Definition at line 102 of file install/include/rtt/os/Mutex.hpp.

RTT::os::Mutex::Mutex

(

)

[inline]

Initialize a Mutex.

Definition at line 92 of file rtt/os/Mutex.hpp.

virtual RTT::os::Mutex::~Mutex

(

)

[inline, virtual]

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

Definition at line 102 of file rtt/os/Mutex.hpp.

---

Member Function Documentation

virtual void RTT::os::Mutex::lock

(

)

[inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 110 of file rtt/os/Mutex.hpp.

virtual void RTT::os::Mutex::lock

(

)

[inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 110 of file install/include/rtt/os/Mutex.hpp.

virtual bool RTT::os::Mutex::timedlock

(

Seconds

s

)

[inline, virtual]

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 139 of file rtt/os/Mutex.hpp.

virtual bool RTT::os::Mutex::timedlock

(

Seconds

s

)

[inline, virtual]

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 139 of file install/include/rtt/os/Mutex.hpp.

virtual bool RTT::os::Mutex::trylock

(

)

[inline, virtual]

Try to lock this mutex

Returns:

true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 125 of file rtt/os/Mutex.hpp.

virtual bool RTT::os::Mutex::trylock

(

)

[inline, virtual]

Try to lock this mutex

Returns:

true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 125 of file install/include/rtt/os/Mutex.hpp.

virtual void RTT::os::Mutex::unlock

(

)

[inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 115 of file rtt/os/Mutex.hpp.

virtual void RTT::os::Mutex::unlock

(

)

[inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 115 of file install/include/rtt/os/Mutex.hpp.

---

Friends And Related Function Documentation

Condition [friend]

Definition at line 84 of file install/include/rtt/os/Mutex.hpp.

---

Member Data Documentation

rt_mutex_t RTT::os::Mutex::m [protected]

Definition at line 87 of file install/include/rtt/os/Mutex.hpp.

---

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

• install/include/rtt/os/Mutex.hpp
• rtt/os/Mutex.hpp