Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
RTT::os::MutexTryLock Class Reference

A MutexTryLock tries to lock an Mutex object on construction and if successful, unlocks it on destruction of the MutexTryLock. Use isSuccessful() to check whether the attempt succeeded. More...

#include <MutexLock.hpp>

Public Member Functions

bool isSuccessful ()
 
 MutexTryLock (MutexInterface &mutex)
 
 ~MutexTryLock ()
 

Protected Member Functions

 MutexTryLock ()
 

Protected Attributes

MutexInterface_mutex
 

Private Attributes

bool successful
 

Detailed Description

A MutexTryLock tries to lock an Mutex object on construction and if successful, unlocks it on destruction of the MutexTryLock. Use isSuccessful() to check whether the attempt succeeded.

Definition at line 87 of file MutexLock.hpp.

Constructor & Destructor Documentation

RTT::os::MutexTryLock::MutexTryLock ( MutexInterface mutex)
inline

Try to lock a Mutex object

Parameters
mutexThe Mutex which should be attempted to be locked

Definition at line 97 of file MutexLock.hpp.

RTT::os::MutexTryLock::~MutexTryLock ( )
inline

Releases, if any, a lock on the previously try-locked Mutex

Definition at line 115 of file MutexLock.hpp.

RTT::os::MutexTryLock::MutexTryLock ( )
inlineprotected

Definition at line 127 of file MutexLock.hpp.

Member Function Documentation

bool RTT::os::MutexTryLock::isSuccessful ( )
inline

Return if the locking of the Mutex was succesfull

Returns
true when the Mutex is locked

Definition at line 107 of file MutexLock.hpp.

Member Data Documentation

MutexInterface* RTT::os::MutexTryLock::_mutex
protected

The Mutex to lock and unlock

Definition at line 125 of file MutexLock.hpp.

bool RTT::os::MutexTryLock::successful
private

Stores the state of success

Definition at line 135 of file MutexLock.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