StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
shared_mutex.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This is the base for StormByte Suite libraries.
5 *
6 * StormByte original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte source in this repository.
20 * They do not cover other StormByte modules or any third-party material
21 * shipped with this repository (including everything under thirdparty/),
22 * which remains under its own license.
23 *
24 * Neither license grants any patent rights. Any patent licenses required
25 * to use this software or third-party components must be obtained separately
26 * from the patent holders.
27 *
28 * StormByte is distributed in the hope that it will be useful,
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 * GNU Lesser General Public License for more details.
32 *
33 * You should have received a copy of the GNU Lesser General Public License
34 * version 3 along with StormByte. If not, see
35 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
36 *
37 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
38 */
39
40#pragma once
41
43
48namespace StormByte {
53 namespace Safe {
61 public:
67
68 SharedMutex(const SharedMutex&) = delete;
69
71
76 ~SharedMutex() noexcept;
77
78 SharedMutex& operator=(const SharedMutex&) = delete;
79
80 SharedMutex& operator=(SharedMutex&&) = delete;
81
86 void lock();
87
92 bool try_lock() noexcept;
93
98 void unlock() noexcept;
99
105
110 bool try_lock_shared() noexcept;
111
116 void unlock_shared() noexcept;
117
118 private:
119 void* m_gate;
120 };
121 }
122}
void lock()
Acquire exclusive ownership.
SharedMutex(const SharedMutex &)=delete
void unlock_shared() noexcept
Release shared ownership.
~SharedMutex() noexcept
Destroys the gate on Base's heap.
void lock_shared()
Acquire shared ownership.
bool try_lock_shared() noexcept
Try to acquire shared ownership.
bool try_lock() noexcept
Try to acquire exclusive ownership.
SharedMutex()
Unlocked shared mutex.
SharedMutex(SharedMutex &&)=delete
void unlock() noexcept
Release exclusive ownership.
Owned values that cross a DLL without the caller's CRT.
Root namespace of the StormByte suite.
#define STORMBYTE_PUBLIC
Definition visibility.h:52