StormByte-Buffer 4.0.0
C++26 buffer module of the StormByte suite
Loading...
Searching...
No Matches
producer.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/safe/owner.hxx>
48
49#include <utility>
50
55namespace StormByte {
60 namespace Buffer {
72 public:
77
83
89 Producer(const Consumer& consumer);
90
96 Producer(const Producer& other);
97
102 Producer(Producer&& other) noexcept;
103
107 ~Producer() noexcept override;
108
115 Producer& operator=(const Producer& other);
116
122 Producer& operator=(Producer&& other) noexcept;
123
127
132
138 bool operator==(const Producer& other) const noexcept;
139
145 inline bool operator!=(const Producer& other) const noexcept {
146 return !(*this == other);
147 }
148
152
157
162 void Close() noexcept override;
163
167 void SetError() noexcept override;
168
173 bool IsWritable() const noexcept override;
174
179 StormByte::ByteSize Size() const noexcept override;
180
184
189
196 bool Write(const StormByte::ByteSize& count, const StormByte::Safe::Binary& data) noexcept override;
197
203 inline bool Write(const StormByte::Safe::Binary& data) noexcept {
204 return Write(data.size(), data);
205 }
206
213 bool Write(const StormByte::ByteSize& count, StormByte::Safe::Binary&& data) noexcept override;
214
220 inline bool Write(StormByte::Safe::Binary&& data) noexcept {
221 return Write(data.size(), std::move(data));
222 }
223
230 bool Write(const StormByte::ByteSize& count, const ReadOnly& data) noexcept override;
231
238 bool Write(const StormByte::ByteSize& count, ReadOnly&& data) noexcept override;
239
243 using WriteOnly::Write;
244
248
254
255 private:
256 StormByte::Safe::Owner m_buffer;
257
262 Ring& Storage() const noexcept;
263 };
264 }
265}
266
Producer(Producer &&other) noexcept
Take a Producer.
Producer(const Producer &other)
Copy a Producer.
StormByte::ByteSize Size() const noexcept override
Bytes stored in the shared Ring.
~Producer() noexcept override
Destroy the Producer.
void Close() noexcept override
Close the shared Ring for further writes and notify waiters.
bool Write(const StormByte::ByteSize &count, const StormByte::Safe::Binary &data) noexcept override
Append bytes from owned storage (copy).
bool Write(const StormByte::ByteSize &count, const ReadOnly &data) noexcept override
Append bytes from a readable buffer (copy).
class Consumer Consumer()
Consumer that shares this Producer's Ring.
Producer(const Consumer &consumer)
Share the Ring of a Consumer.
bool Write(const StormByte::ByteSize &count, StormByte::Safe::Binary &&data) noexcept override
Append bytes from owned storage (move).
bool IsWritable() const noexcept override
Whether the shared Ring still accepts writes.
bool Write(const StormByte::ByteSize &count, ReadOnly &&data) noexcept override
Append bytes from a readable buffer (extract path).
bool Write(StormByte::Safe::Binary &&data) noexcept
Append an entire owned buffer (move).
Definition producer.hxx:220
Producer()
Create a Producer and a new shared Ring.
void SetError() noexcept override
Put the shared Ring in a permanent error state and notify waiters.
Buffer that can be read and not written.
Definition generic.hxx:220
Highly concurrent thread-safe ring buffer.
Definition ring.hxx:90
virtual bool Write(const StormByte::ByteSize &count, const Safe::Binary &data) noexcept=0
Append bytes from a StormByte::Safe::Binary (copy).
WriteOnly() noexcept
Default constructor.
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Buffer module of the StormByte suite.
Detail::Owner Owner
Root namespace of the StormByte C++ suite.
#define STORMBYTE_BUFFER_PUBLIC
Definition visibility.h:54