Public Member Functions | Protected Attributes | List of all members
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]

Public Member Functions

void lock ()
 
 MutexRecursive ()
 
virtual bool timedlock (Seconds s)
 
virtual bool trylock ()
 
virtual void unlock ()
 
virtual ~MutexRecursive ()
 
- 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_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 218 of file Mutex.hpp.

Constructor & Destructor Documentation

RTT::os::MutexRecursive::MutexRecursive ( )
inline

Initialize a recursive Mutex.

Definition at line 227 of file Mutex.hpp.

virtual RTT::os::MutexRecursive::~MutexRecursive ( )
inlinevirtual

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

Definition at line 237 of file Mutex.hpp.

Member Function Documentation

void RTT::os::MutexRecursive::lock ( )
inlinevirtual

Implements RTT::os::MutexInterface.

Definition at line 245 of file Mutex.hpp.

virtual bool RTT::os::MutexRecursive::timedlock ( Seconds  s)
inlinevirtual

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 274 of file Mutex.hpp.

virtual bool RTT::os::MutexRecursive::trylock ( )
inlinevirtual

Try to lock this mutex

Returns
true when the locking succeeded, false otherwise

Implements RTT::os::MutexInterface.

Definition at line 260 of file Mutex.hpp.

virtual void RTT::os::MutexRecursive::unlock ( )
inlinevirtual

Implements RTT::os::MutexInterface.

Definition at line 250 of file Mutex.hpp.

Member Data Documentation

rt_rec_mutex_t RTT::os::MutexRecursive::recm
protected

Definition at line 222 of file Mutex.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:46