producer.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Buffer.
 *
 * StormByte-Buffer original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Buffer source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, and in particular the bundled StormByte-Logger tree and
 * the rest of the StormByte suite it vendors), which remains under its own
 * license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Buffer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/buffer/consumer.hxx>
 
namespace StormByte {
    namespace Buffer {
        class STORMBYTE_BUFFER_PUBLIC Producer final : public WriteOnly {
            public:
                inline Producer() noexcept : m_buffer(std::make_shared<Ring>()) {}
 
                inline explicit Producer(std::shared_ptr<Ring> buffer) noexcept
                    : m_buffer(std::move(buffer)) {}
 
                inline Producer(const Consumer& consumer) noexcept
                    : m_buffer(consumer.m_buffer) {}
 
                inline Producer(const Producer& other) noexcept : m_buffer(other.m_buffer) {}
 
                inline Producer(Producer&& other) noexcept : m_buffer(std::move(other.m_buffer)) {}
 
                ~Producer() noexcept override;
 
                inline Producer& operator=(const Producer& other) noexcept {
                    if (this != &other)
                        m_buffer = other.m_buffer;
                    return *this;
                }
 
                inline Producer& operator=(Producer&& other) noexcept {
                    if (this != &other)
                        m_buffer = std::move(other.m_buffer);
                    return *this;
                }
 
                inline bool operator==(const Producer& other) const noexcept {
                    return m_buffer.get() == other.m_buffer.get();
                }
 
                inline bool operator!=(const Producer& other) const noexcept {
                    return !(*this == other);
                }
 
                void Close() noexcept override;
 
                void SetError() noexcept override;
 
                bool IsWritable() const noexcept override;
 
                StormByte::ByteSize Size() const noexcept override;
 
                bool Write(const StormByte::ByteSize& count, const BinaryData& data) noexcept override;
 
                inline bool Write(const BinaryData& data) noexcept {
                    return Write(data.size(), data);
                }
 
                bool Write(const StormByte::ByteSize& count, BinaryData&& data) noexcept override;
 
                inline bool Write(BinaryData&& data) noexcept {
                    return Write(data.size(), std::move(data));
                }
 
                bool Write(const StormByte::ByteSize& count, const ReadOnly& data) noexcept override;
 
                bool Write(const StormByte::ByteSize& count, ReadOnly&& data) noexcept override;
 
                using WriteOnly::Write;
 
                inline class Consumer Consumer() {
                    return StormByte::Buffer::Consumer{ m_buffer };
                }
 
            protected:
                std::shared_ptr<Ring> m_buffer; 
        };
    }
}