StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
typedefs.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-Buffer.
5 *
6 * StormByte-Buffer 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-Buffer 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-Logger tree and
23 * the rest of the StormByte suite it vendors), which remains under its own
24 * license.
25 *
26 * Neither license grants any patent rights. Any patent licenses required
27 * to use this software or third-party components must be obtained separately
28 * from the patent holders.
29 *
30 * StormByte-Buffer is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU Lesser General Public License for more details.
34 *
35 * You should have received a copy of the GNU Lesser General Public License
36 * version 3 along with StormByte-Buffer. If not, see
37 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
38 *
39 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
40 */
41
42#pragma once
43
44#include <StormByte/type_traits/safe.hxx>
45
47#include <StormByte/byte_size.hxx>
48#include <StormByte/expected.hxx>
49#include <StormByte/logger/log.hxx>
50
51#include <cstddef>
52#include <functional>
53#include <memory>
54#include <span>
55
60namespace StormByte::Buffer {
61 class Consumer;
62 class Producer;
63 class ReadOnly;
64 class WriteOnly;
65
78
107 Sync = 0,
108 Async = 1u << 0,
109 Parallel = 1u << 1
110 };
111
118 inline constexpr ExecutionMode operator|(ExecutionMode a, ExecutionMode b) noexcept {
119 return static_cast<ExecutionMode>(
120 static_cast<unsigned>(a) | static_cast<unsigned>(b));
121 }
122
129 inline constexpr ExecutionMode operator&(ExecutionMode a, ExecutionMode b) noexcept {
130 return static_cast<ExecutionMode>(
131 static_cast<unsigned>(a) & static_cast<unsigned>(b));
132 }
133
140 inline constexpr ExecutionMode& operator|=(ExecutionMode& a, ExecutionMode b) noexcept {
141 a = a | b;
142 return a;
143 }
144
151 inline constexpr bool HasExecutionFlag(ExecutionMode mode, ExecutionMode flag) noexcept {
152 return (static_cast<unsigned>(mode) & static_cast<unsigned>(flag)) ==
153 static_cast<unsigned>(flag);
154 }
155}
Read-oriented handle over a shared Ring.
Definition consumer.hxx:80
Write-only handle over a shared Ring.
Definition producer.hxx:71
Buffer that can be read and not written.
Definition generic.hxx:220
Buffer that can be written and not read.
Definition generic.hxx:497
Buffer module of the StormByte suite.
constexpr bool HasExecutionFlag(ExecutionMode mode, ExecutionMode flag) noexcept
Whether mode includes all bits of flag.
Definition typedefs.hxx:151
constexpr ExecutionMode operator|(ExecutionMode a, ExecutionMode b) noexcept
Bitwise OR of execution flags.
Definition typedefs.hxx:118
constexpr ExecutionMode operator&(ExecutionMode a, ExecutionMode b) noexcept
Bitwise AND of execution flags.
Definition typedefs.hxx:129
ExecutionMode
Bitmask controlling how Pipeline::Process schedules work.
Definition typedefs.hxx:106
@ Async
Background execution; Process returns immediately.
Definition typedefs.hxx:108
@ Parallel
One thread per stage (pipeline parallelism).
Definition typedefs.hxx:109
@ Sync
Sequential on caller thread; Process blocks.
Definition typedefs.hxx:107
constexpr ExecutionMode & operator|=(ExecutionMode &a, ExecutionMode b) noexcept
Bitwise OR-assignment of execution flags.
Definition typedefs.hxx:140
Position
Forward declaration of the WriteOnly interface.
Definition typedefs.hxx:74
@ Relative
Offset from the current logical read position.
Definition typedefs.hxx:76
@ Absolute
Offset from the beginning of the buffer (position 0).
Definition typedefs.hxx:75
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54