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 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * or later, as published by the Free Software Foundation.
 *
 * 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
 * along with StormByte-Buffer. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 */
 
#pragma once
 
#include <StormByte/buffer/ring.hxx>
 
#include <memory>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC Consumer final: public ReadOnly {
        friend class Producer;
 
        public:
            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);
            }
 
            std::size_t AvailableBytes() const noexcept override;
 
            const DataType& 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();
            }
 
            std::size_t Size() const noexcept override;
 
            void Clean() noexcept override;
 
            void Clear() noexcept override;
 
            inline void Close() noexcept {
                m_buffer->Close();
            }
 
            bool Drop(const std::size_t& count) noexcept override;
 
            void Seek(const std::ptrdiff_t& offset, const Position& mode) const noexcept override;
 
            bool Extract(const std::size_t& count, DataType& out) noexcept override;
 
            bool Extract(const std::size_t& count, WriteOnly& out) noexcept override;
 
            void ExtractUntilEoF(DataType& out) noexcept override;
 
            void ExtractUntilEoF(WriteOnly& out) noexcept override;
 
            bool Read(const std::size_t& count, DataType& out) const noexcept override;
 
            bool Read(const std::size_t& count, WriteOnly& out) const noexcept override;
 
            void ReadUntilEoF(DataType& out) const noexcept override;
 
            void ReadUntilEoF(WriteOnly& out) const noexcept override;
 
            bool Peek(const std::size_t& count, DataType& out) const noexcept override;
 
            bool Peek(const std::size_t& 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)) {}
    };
}