A MutexTimedLock locks a Mutex object on construction and if successful, unlocks it on destruction of the MutexTimedLock. If the lock can not be acquired within the user provided time limit, the attempt is aborted. Use isSuccessful() to check whether the attempt succeeded.
More...
#include <MutexLock.hpp>
A MutexTimedLock locks a Mutex object on construction and if successful, unlocks it on destruction of the MutexTimedLock. If the lock can not be acquired within the user provided time limit, the attempt is aborted. Use isSuccessful() to check whether the attempt succeeded.
Definition at line 146 of file MutexLock.hpp.
Lock a Mutex object, but don't block longer than a specified timeout.
- Parameters
-
mutex | The Mutex which should be attempted to be locked |
timeout | The maximum time to wait in seconds. |
Definition at line 158 of file MutexLock.hpp.
RTT::os::MutexTimedLock::~MutexTimedLock |
( |
| ) |
|
|
inline |
Releases, if any, a lock on the previously try-locked Mutex
Definition at line 176 of file MutexLock.hpp.
RTT::os::MutexTimedLock::MutexTimedLock |
( |
| ) |
|
|
inlineprotected |
bool RTT::os::MutexTimedLock::isSuccessful |
( |
| ) |
|
|
inline |
Return if the locking of the Mutex was succesfull
- Returns
- true when the Mutex is locked
Definition at line 168 of file MutexLock.hpp.
bool RTT::os::MutexTimedLock::successful |
|
private |
The documentation for this class was generated from the following file: