StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
pipeline.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
52#include <StormByte/logger/log.hxx>
53#include <StormByte/safe/pointers.hxx>
54
55#include <memory>
56
61namespace StormByte {
66 namespace Buffer {
96 public:
101
105 Pipeline() noexcept;
106
111 Pipeline(const Pipeline& other);
112
117 Pipeline(Pipeline&& other) noexcept;
118
122 ~Pipeline() noexcept;
123
129 Pipeline& operator=(const Pipeline& other);
130
136 Pipeline& operator=(Pipeline&& other) noexcept;
137
141
146
152 void Add(const Pipe& pipe);
153
158 void Add(Pipe&& pipe);
159
163
168
172 void SetError() const noexcept;
173
185 const StormByte::Safe::Shared<StormByte::Logger::Log>& log,
186 const ExecutionMode& mode) const noexcept;
187
191
192 private:
197 struct Backend;
198
202 std::unique_ptr<Backend> m_io;
203 };
204 }
205}
206
Read-oriented handle over a shared Ring.
Definition consumer.hxx:80
One transformation in a Pipeline.
Definition pipe.hxx:199
Consumer Process(Consumer buffer, const StormByte::Safe::Shared< StormByte::Logger::Log > &log, const ExecutionMode &mode) const noexcept
Run the pipes.
void SetError() const noexcept
SetError on every intermediate ring and the final Producer.
Pipeline() noexcept
Construct an empty pipeline.
void Add(const Pipe &pipe)
Copy pipe and independently clone its callable state.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
PIMPL coordinators for public Buffer types that are not IO.
Buffer module of the StormByte suite.
ExecutionMode
Bitmask controlling how Pipeline::Process schedules work.
Definition typedefs.hxx:106
Root namespace of the StormByte C++ suite.
STL namespace.
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54