OpenShot Audio Library | OpenShotAudio: juce_ScopedWriteLock.h Source File

OpenShot Audio Library | OpenShotAudio 1.0.0

Loading...
Searching...
No Matches
juce_ScopedWriteLock.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 ScopedWriteLock
52{
53public:
54 //==============================================================================
65 inline explicit ScopedWriteLock (const ReadWriteLock& lock) noexcept : lock_ (lock) { lock.enterWrite(); }
66
74 inline ~ScopedWriteLock() noexcept { lock_.exitWrite(); }
75
76
77private:
78 //==============================================================================
79 const ReadWriteLock& lock_;
80
81 JUCE_DECLARE_NON_COPYABLE (ScopedWriteLock)
82};
83
84//==============================================================================
119 class JUCE_API ScopedTryWriteLock
120{
121public:
122 //==============================================================================
131 ScopedTryWriteLock (ReadWriteLock& lockIn) noexcept
132 : ScopedTryWriteLock (lockIn, true) {}
133
144 ScopedTryWriteLock (ReadWriteLock& lockIn, bool acquireLockOnInitialisation) noexcept
145 : lock (lockIn), lockWasSuccessful (acquireLockOnInitialisation && lock.tryEnterWrite()) {}
146
154 ~ScopedTryWriteLock() noexcept { if (lockWasSuccessful) lock.exitWrite(); }
155
157 bool isLocked() const noexcept { return lockWasSuccessful; }
158
160 bool retryLock() noexcept { return lockWasSuccessful = lock.tryEnterWrite(); }
161
162private:
163 //==============================================================================
164 ReadWriteLock& lock;
165 bool lockWasSuccessful;
166
167 JUCE_DECLARE_NON_COPYABLE (ScopedTryWriteLock)
168};
169
170}
juce::ReadWriteLock
Definition juce_ReadWriteLock.h:48
juce::ScopedTryWriteLock
Definition juce_ScopedWriteLock.h:120
juce::ScopedTryWriteLock::retryLock
bool retryLock() noexcept
Definition juce_ScopedWriteLock.h:160
juce::ScopedTryWriteLock::ScopedTryWriteLock
ScopedTryWriteLock(ReadWriteLock &lockIn, bool acquireLockOnInitialisation) noexcept
Definition juce_ScopedWriteLock.h:144
juce::ScopedTryWriteLock::ScopedTryWriteLock
ScopedTryWriteLock(ReadWriteLock &lockIn) noexcept
Definition juce_ScopedWriteLock.h:131
juce::ScopedTryWriteLock::~ScopedTryWriteLock
~ScopedTryWriteLock() noexcept
Definition juce_ScopedWriteLock.h:154
juce::ScopedTryWriteLock::isLocked
bool isLocked() const noexcept
Definition juce_ScopedWriteLock.h:157
juce::ScopedWriteLock
Definition juce_ScopedWriteLock.h:52
juce::ScopedWriteLock::ScopedWriteLock
ScopedWriteLock(const ReadWriteLock &lock) noexcept
Definition juce_ScopedWriteLock.h:65
juce::ScopedWriteLock::~ScopedWriteLock
~ScopedWriteLock() noexcept
Definition juce_ScopedWriteLock.h:74