OpenShot Library | libopenshot-audio 0.2.0
juce::ScopedReadLock Class Reference

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

#include <juce_ScopedReadLock.h>

Public Member Functions

 ScopedReadLock (const ReadWriteLock &lock) noexcept
 Creates a ScopedReadLock.
 
 ~ScopedReadLock () noexcept
 Destructor.
 

Detailed Description

Automatically locks and unlocks a ReadWriteLock object.

Use one of these as a local variable to control access to a ReadWriteLock.

e.g.

for (;;)
{
// myLock is now locked
...do some stuff...
// myLock gets unlocked here.
}
Holds a resizable array of primitive or copy-by-value objects.
Definition juce_Array.h:60
A critical section that allows multiple simultaneous readers.
Automatically locks and unlocks a ReadWriteLock object.
See also
ReadWriteLock, ScopedWriteLock

Definition at line 55 of file juce_ScopedReadLock.h.

Constructor & Destructor Documentation

◆ ScopedReadLock()

juce::ScopedReadLock::ScopedReadLock ( const ReadWriteLock lock)
inlineexplicitnoexcept

Creates a ScopedReadLock.

As soon as it is created, this will call ReadWriteLock::enterRead(), and when the ScopedReadLock object is deleted, the ReadWriteLock will be unlocked.

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.

Definition at line 69 of file juce_ScopedReadLock.h.

◆ ~ScopedReadLock()

juce::ScopedReadLock::~ScopedReadLock ( )
inlinenoexcept

Destructor.

The ReadWriteLock's exitRead() method will be called 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!

Definition at line 78 of file juce_ScopedReadLock.h.


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