Public Member Functions | Protected Attributes
RTT::os::MutexRecursive Class Reference

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

#include <Mutex.hpp>

Inheritance diagram for RTT::os::MutexRecursive:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void lock ()
 MutexRecursive ()
virtual bool timedlock (Seconds s)
virtual bool trylock ()
virtual void unlock ()
virtual ~MutexRecursive ()

Protected Attributes

rt_rec_mutex_t recm

Detailed Description

An object oriented wrapper around a 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.

See also:
MutexLock, MutexTryLock, Mutex

Definition at line 208 of file Mutex.hpp.


Constructor & Destructor Documentation

Initialize a recursive Mutex.

Definition at line 217 of file Mutex.hpp.

virtual RTT::os::MutexRecursive::~MutexRecursive ( ) [inline, virtual]

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

Definition at line 227 of file Mutex.hpp.


Member Function Documentation

void RTT::os::MutexRecursive::lock ( ) [inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 235 of file Mutex.hpp.

virtual bool RTT::os::MutexRecursive::timedlock ( Seconds  s) [inline, virtual]

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

Parameters:
sThe maximum time to wait before aqcuiring the lock.
Returns:
true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 264 of file Mutex.hpp.

virtual bool RTT::os::MutexRecursive::trylock ( ) [inline, virtual]

Try to lock this mutex

Returns:
true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 250 of file Mutex.hpp.

virtual void RTT::os::MutexRecursive::unlock ( ) [inline, virtual]

Implements RTT::os::MutexInterface.

Definition at line 240 of file Mutex.hpp.


Member Data Documentation

Definition at line 212 of file Mutex.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Thu Jan 2 2014 11:35:45