RTT::OS::MutexTimedLock Class Reference

A MutexTimedLock locks a Mutex object on construction and if successful, unlocks it on destruction of the MutexTimedLock. More...

#include <rtt/os/MutexLock.hpp>

List of all members.

Public Member Functions
	MutexTimedLock (OS::MutexInterface &mutex, Seconds timeout)
	Lock a Mutex object, but don't block longer than a specified timeout.
bool	isSuccessful ()
	Return if the locking of the Mutex was succesfull.
	~MutexTimedLock ()
	Releases, if any, a lock on the previously try-locked Mutex.
Protected Attributes
OS::MutexInterface *	_mutex
	The Mutex to lock and unlock.

---

Detailed Description

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.

---

Constructor & Destructor Documentation

RTT::OS::MutexTimedLock::MutexTimedLock	(	OS::MutexInterface &	mutex,
		Seconds	timeout
	)			[inline]

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.

---

Member Function Documentation

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.

---

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

• rtt/os/MutexLock.hpp