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>

List of all members.

Public Member Functions
bool	isSuccessful ()
bool	isSuccessful ()
	MutexTryLock (MutexInterface &mutex)
	MutexTryLock (MutexInterface &mutex)
	~MutexTryLock ()
	~MutexTryLock ()
Protected Member Functions
	MutexTryLock ()
	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 install/include/rtt/os/MutexLock.hpp.

---

Constructor & Destructor Documentation

RTT::os::MutexTryLock::MutexTryLock

(

MutexInterface &

mutex

)

[inline]

Try to lock a Mutex object

Parameters:

mutex

The Mutex which should be attempted to be locked

Definition at line 97 of file install/include/rtt/os/MutexLock.hpp.

RTT::os::MutexTryLock::~MutexTryLock

(

)

[inline]

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

Definition at line 115 of file install/include/rtt/os/MutexLock.hpp.

RTT::os::MutexTryLock::MutexTryLock

(

)

[inline, protected]

Definition at line 127 of file install/include/rtt/os/MutexLock.hpp.

RTT::os::MutexTryLock::MutexTryLock

(

MutexInterface &

mutex

)

[inline]

Try to lock a Mutex object

Parameters:

mutex

The Mutex which should be attempted to be locked

Definition at line 97 of file rtt/os/MutexLock.hpp.

RTT::os::MutexTryLock::~MutexTryLock

(

)

[inline]

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

Definition at line 115 of file rtt/os/MutexLock.hpp.

RTT::os::MutexTryLock::MutexTryLock

(

)

[inline, protected]

Definition at line 127 of file rtt/os/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 rtt/os/MutexLock.hpp.

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 install/include/rtt/os/MutexLock.hpp.

---

Member Data Documentation

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

The Mutex to lock and unlock

Definition at line 125 of file install/include/rtt/os/MutexLock.hpp.

bool RTT::os::MutexTryLock::successful [private]

Stores the state of success

Definition at line 135 of file install/include/rtt/os/MutexLock.hpp.

---

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

• install/include/rtt/os/MutexLock.hpp
• rtt/os/MutexLock.hpp