StormByte 3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
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 {
55
63 public:
69
70 Mutex(const Mutex&) = delete;
71
72 Mutex(Mutex&&) = delete;
73
78 ~Mutex() noexcept;
79
80 Mutex& operator=(const Mutex&) = delete;
81
82 Mutex& operator=(Mutex&&) = delete;
83
88 void lock();
89
94 bool try_lock() noexcept;
95
100 void unlock() noexcept;
101
102 private:
103 friend class ConditionVariable;
104
105 void* m_gate;
106 };
107 }
108}
Wakes threads waiting on a Mutex.
Definition condition_variable.hxx:64
void lock()
Acquire the mutex.
~Mutex() noexcept
Destroys the gate on Base's heap.
Mutex(const Mutex &)=delete
Mutex()
Unlocked mutex.
friend class ConditionVariable
Definition mutex.hxx:103
Mutex(Mutex &&)=delete
bool try_lock() noexcept
Try to acquire the mutex.
void unlock() noexcept
Release the mutex.
Owned values that cross a DLL without the caller's CRT.
Root namespace of the StormByte suite.
#define STORMBYTE_PUBLIC
Definition visibility.h:52