StormByte-System 2.0.0
C++26 process and environment module of the StormByte suite
 
Loading...
Searching...
No Matches
this_thread.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-System.
5 *
6 * StormByte-System 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-System source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Base tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-System is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-System. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
43#include <StormByte/error.hxx>
46
47#include <chrono>
48#include <string>
49#include <string_view>
50#include <system_error>
51#include <thread>
52
56namespace StormByte::System {
64 namespace ThisThread {
71 enum class Error {
72 Success = 0,
73 TooLong,
74 Failed
75 };
76
82
89 template<typename Rep, typename Period>
90 inline void Sleep(const std::chrono::duration<Rep, Period>& duration) {
91 std::this_thread::sleep_for(duration);
92 }
93
99 STORMBYTE_SYSTEM_PUBLIC bool Name(std::string_view name);
100
107 }
108}
109
113template<>
115 static constexpr const char* Name = "StormByte.System.ThisThread";
116
123 switch (e) {
125 return "Success";
127 return "Thread name is too long";
129 return "Thread name operation failed";
130 }
131 return "Unknown ThisThread error";
132 }
133};
134
135namespace StormByte::System {
141
147 STORMBYTE_SYSTEM_PUBLIC std::error_code make_error_code(ThisThread::Error e) noexcept;
148}
149
150namespace std {
154 template<>
155 struct is_error_code_enum<StormByte::System::ThisThread::Error>: true_type {};
156}
void Sleep(const std::chrono::duration< Rep, Period > &duration)
Suspend the calling thread.
Definition this_thread.hxx:90
Error
ThisThread enumerators.
Definition this_thread.hxx:71
@ TooLong
The name exceeds the platform limit.
@ Failed
The platform call failed.
bool Name(std::string_view name)
Set the calling thread name.
StormByte::Error::Fault LastError() noexcept
Last ThisThread error on this thread.
System module of the StormByte suite.
Definition device.hxx:58
std::error_code make_error_code(Device::Error e) noexcept
Builds an std::error_code from Device::Error.
const StormByte::Error::Category< ThisThread::Error > & this_thread_category() noexcept
Category singleton for ThisThread::Error.
STL namespace.
static std::string Message(StormByte::System::ThisThread::Error e)
Text for one ThisThread enumerator.
Definition this_thread.hxx:122
#define STORMBYTE_SYSTEM_PUBLIC
Definition visibility.h:53