StormByte
3.0.0
C++26 foundation of the StormByte suite
Loading...
Searching...
No Matches
thread_lock.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
42
#include <
StormByte/visibility.h
>
43
44
#include <mutex>
45
#include <optional>
46
#include <thread>
47
52
namespace
StormByte
{
61
class
STORMBYTE_PUBLIC
ThreadLock
final {
62
public
:
66
ThreadLock
() noexcept = default;
67
71
ThreadLock
(const
ThreadLock
&) = delete;
72
76
ThreadLock
(
ThreadLock
&&) = delete;
77
82
~
ThreadLock
() noexcept;
83
87
ThreadLock
& operator=(const
ThreadLock
&) = delete;
88
92
ThreadLock
& operator=(
ThreadLock
&&) = delete;
93
100
void
Lock
() noexcept;
101
107
void
Unlock
() noexcept;
108
109
private:
110
std
::optional<
std
::thread::
id
> m_owner_thread_id;
111
std
::mutex m_main_mutex;
112
std
::mutex m_thread_owner_mutex;
113
};
114
}
StormByte::ThreadLock::Lock
void Lock() noexcept
Acquire the lock.
StormByte::ThreadLock::Unlock
void Unlock() noexcept
Release ownership.
StormByte::ThreadLock::ThreadLock
ThreadLock() noexcept=default
Unlocked lock, no owner.
StormByte
Root namespace of the StormByte suite.
std
STL namespace.
visibility.h
STORMBYTE_PUBLIC
#define STORMBYTE_PUBLIC
Definition
visibility.h:52
lib
public
StormByte
thread_lock.hxx
Generated by
1.15.0