OpenShot Audio Library | OpenShotAudio: juce_ScopedReadLock.h Source File

OpenShot Audio Library | OpenShotAudio 0.4.0

Loading...
Searching...
No Matches
juce_ScopedReadLock.h
1/*
2 ==============================================================================
3
4 This file is part of the JUCE library.
5 Copyright (c) 2022 - Raw Material Software Limited
6
7 JUCE is an open source library subject to commercial or open-source
8 licensing.
9
10 The code included in this file is provided under the terms of the ISC license
11 http://www.isc.org/downloads/software-support-policy/isc-license. Permission
12 To use, copy, modify, and/or distribute this software for any purpose with or
13 without fee is hereby granted provided that the above copyright notice and
14 this permission notice appear in all copies.
15
16 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
17 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
18 DISCLAIMED.
19
20 ==============================================================================
21*/
22
23namespace juce
24{
25
26//==============================================================================
51 class JUCE_API ScopedReadLock
52{
53public:
54 //==============================================================================
65 inline explicit ScopedReadLock (const ReadWriteLock& lock) noexcept : lock_ (lock) { lock.enterRead(); }
66
74 inline ~ScopedReadLock() noexcept { lock_.exitRead(); }
75
76
77private:
78 //==============================================================================
79 const ReadWriteLock& lock_;
80
81 JUCE_DECLARE_NON_COPYABLE (ScopedReadLock)
82};
83
84//==============================================================================
119 class JUCE_API ScopedTryReadLock
120{
121public:
122 //==============================================================================
131 explicit ScopedTryReadLock (ReadWriteLock& lockIn)
132 : ScopedTryReadLock (lockIn, true) {}
133
144 ScopedTryReadLock (ReadWriteLock& lockIn, bool acquireLockOnInitialisation) noexcept
145 : lock (lockIn), lockWasSuccessful (acquireLockOnInitialisation && lock.tryEnterRead()) {}
146
154 ~ScopedTryReadLock() noexcept { if (lockWasSuccessful) lock.exitRead(); }
155
157 bool isLocked() const noexcept { return lockWasSuccessful; }
158
160 bool retryLock() noexcept { return lockWasSuccessful = lock.tryEnterRead(); }
161
162private:
163 //==============================================================================
164 ReadWriteLock& lock;
165 bool lockWasSuccessful;
166
167 JUCE_DECLARE_NON_COPYABLE (ScopedTryReadLock)
168};
169
170} // namespace juce
juce::ReadWriteLock
Definition juce_ReadWriteLock.h:48
juce::ScopedReadLock
Definition juce_ScopedReadLock.h:52
juce::ScopedReadLock::~ScopedReadLock
~ScopedReadLock() noexcept
Definition juce_ScopedReadLock.h:74
juce::ScopedReadLock::ScopedReadLock
ScopedReadLock(const ReadWriteLock &lock) noexcept
Definition juce_ScopedReadLock.h:65
juce::ScopedTryReadLock
Definition juce_ScopedReadLock.h:120
juce::ScopedTryReadLock::~ScopedTryReadLock
~ScopedTryReadLock() noexcept
Definition juce_ScopedReadLock.h:154
juce::ScopedTryReadLock::ScopedTryReadLock
ScopedTryReadLock(ReadWriteLock &lockIn, bool acquireLockOnInitialisation) noexcept
Definition juce_ScopedReadLock.h:144
juce::ScopedTryReadLock::ScopedTryReadLock
ScopedTryReadLock(ReadWriteLock &lockIn)
Definition juce_ScopedReadLock.h:131
juce::ScopedTryReadLock::isLocked
bool isLocked() const noexcept
Definition juce_ScopedReadLock.h:157
juce::ScopedTryReadLock::retryLock
bool retryLock() noexcept
Definition juce_ScopedReadLock.h:160