JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
GenericScopedTryLock< LockType > Class Template Reference

Automatically locks and unlocks a mutex object. More...

Public Member Functions

 GenericScopedTryLock (const LockType &lock) noexcept
 Creates a GenericScopedTryLock.
 
 ~GenericScopedTryLock () noexcept
 Destructor.
 
bool isLocked () const noexcept
 Returns true if the mutex was successfully locked.
 

Detailed Description

template<class LockType>
class GenericScopedTryLock< LockType >

Automatically locks and unlocks a mutex object.

Use one of these as a local variable to provide RAII-based locking of a mutex.

The templated class could be a CriticalSection, SpinLock, or anything else that provides enter() and exit() methods.

e.g.

CriticalSection myCriticalSection;
for (;;)
{
const GenericScopedTryLock<CriticalSection> myScopedTryLock (myCriticalSection);
// Unlike using a ScopedLock, this may fail to actually get the lock, so you
// should test this with the isLocked() method before doing your thread-unsafe
// action..
if (myScopedTryLock.isLocked())
{
...do some stuff...
}
else
{
..our attempt at locking failed because another thread had already locked it..
}
// myCriticalSection gets unlocked here (if it was locked)
}
See Also
CriticalSection::tryEnter, GenericScopedLock, GenericScopedUnlock

Constructor & Destructor Documentation

template<class LockType>
GenericScopedTryLock< LockType >::GenericScopedTryLock ( const LockType &  lock)
explicitnoexcept

Creates a GenericScopedTryLock.

As soon as it is created, this will attempt to acquire the lock, and when the GenericScopedTryLock is deleted, the lock will be released (if the lock was successfully acquired).

Make sure this object is created and deleted by the same thread, otherwise there are no guarantees what will happen! Best just to use it as a local stack object, rather than creating one with the new() operator.

template<class LockType>
GenericScopedTryLock< LockType >::~GenericScopedTryLock ( )
noexcept

Destructor.

The mutex will be unlocked (if it had been successfully locked) when the destructor is called.

Make sure this object is created and deleted by the same thread, otherwise there are no guarantees what will happen!

Member Function Documentation

template<class LockType>
bool GenericScopedTryLock< LockType >::isLocked ( ) const
noexcept

Returns true if the mutex was successfully locked.


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