JUCE: ScopedReadLock Class Reference

JUCE

Public Member Functions | List of all members
ScopedReadLock Class Reference
juce_core » threads

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

`#include <juce_ScopedReadLock.h>`

## Public Member Functions
| ScopedReadLock (const ReadWriteLock &lock) noexcept
| Creates a ScopedReadLock. More...
| ~ScopedReadLock () noexcept
| Destructor. More...

## 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.

ReadWriteLock myLock;
for (;;)
{
const ScopedReadLock myScopedLock (myLock);
// myLock is now locked
...do some stuff...
// myLock gets unlocked here.
}
ReadWriteLock
A critical section that allows multiple simultaneous readers.
Definition: juce_ReadWriteLock.h:49
ScopedReadLock
Automatically locks and unlocks a ReadWriteLock object.
Definition: juce_ScopedReadLock.h:53

See also
  ReadWriteLock, ScopedWriteLock

## Constructor & Destructor Documentation

## ◆ ScopedReadLock()

ScopedReadLock::ScopedReadLock | ( | const ReadWriteLock & | lock | ) |
| explicitnoexcept

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.

## ◆ ~ScopedReadLock()

ScopedReadLock::~ScopedReadLock | ( |  | ) |
| noexcept

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!

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

- juce_ScopedReadLock.h