consumer.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/ring.hxx>
 
#include <memory>
 
namespace StormByte {
    namespace Buffer {
        class Producer;
 
        class STORMBYTE_BUFFER_PUBLIC Consumer final: public ReadOnly {
            friend class Producer;
 
            public:
                inline Consumer() noexcept : m_buffer(std::make_shared<Ring>()) {}
 
                inline Consumer(const Consumer& other) noexcept : m_buffer(other.m_buffer) {}
 
                inline Consumer(Consumer&& other) noexcept : m_buffer(std::move(other.m_buffer)) {}
 
                ~Consumer() noexcept override;
 
                inline Consumer& operator=(const Consumer& other) noexcept {
                    if (this != &other)
                        m_buffer = other.m_buffer;
                    return *this;
                }
 
                inline Consumer& operator=(Consumer&& other) noexcept {
                    if (this != &other)
                        m_buffer = std::move(other.m_buffer);
                    return *this;
                }
 
                inline bool operator==(const Consumer& other) const noexcept {
                    return m_buffer.get() == other.m_buffer.get();
                }
 
                inline bool operator!=(const Consumer& other) const noexcept {
                    return !(*this == other);
                }
 
                StormByte::ByteSize Available() const noexcept override;
 
                const StormByte::BinaryData& Data() const noexcept override;
 
                bool Empty() const noexcept override;
 
                bool EoF() const noexcept override;
 
                bool IsReadable() const noexcept override;
 
                inline bool IsWritable() const noexcept {
                    return m_buffer->IsWritable();
                }
 
                inline bool HasError() const noexcept {
                    return m_buffer->HasError();
                }
 
                StormByte::ByteSize Size() const noexcept override;
 
                class Producer Producer() const noexcept;
 
                void Clean() noexcept override;
 
                void Clear() noexcept override;
 
                inline void Close() noexcept {
                    m_buffer->Close();
                }
 
                bool Drop(const StormByte::ByteSize& count) noexcept override;
 
                void Seek(const std::ptrdiff_t& offset, const Position& mode) const noexcept override;
 
                bool Extract(const StormByte::ByteSize& count, StormByte::BinaryData& out) noexcept override;
 
                bool Extract(const StormByte::ByteSize& count, WriteOnly& out) noexcept override;
 
                void ExtractUntilEoF(StormByte::BinaryData& out) noexcept override;
 
                void ExtractUntilEoF(WriteOnly& out) noexcept override;
 
                bool Read(const StormByte::ByteSize& count, StormByte::BinaryData& out) const noexcept override;
 
                bool Read(const StormByte::ByteSize& count, WriteOnly& out) const noexcept override;
 
                void ReadUntilEoF(StormByte::BinaryData& out) const noexcept override;
 
                void ReadUntilEoF(WriteOnly& out) const noexcept override;
 
                bool Peek(const StormByte::ByteSize& count, StormByte::BinaryData& out) const noexcept override;
 
                bool Peek(const StormByte::ByteSize& count, WriteOnly& out) const noexcept override;
 
            private:
                std::shared_ptr<Ring> m_buffer; 
 
                inline explicit Consumer(std::shared_ptr<Ring> buffer) noexcept
                    : m_buffer(std::move(buffer)) {}
        };
    }
}