shared_fifo.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/fifo.hxx>
#include <StormByte/type_traits.hxx>
 
#include <condition_variable>
#include <mutex>
#include <string_view>
 
namespace StormByte::Buffer {
    class STORMBYTE_BUFFER_PUBLIC SharedFIFO : public FIFO {
        public:
            SharedFIFO() noexcept = default;
 
            inline SharedFIFO(const StormByte::BinaryData& data) : FIFO(data) {}
 
            inline SharedFIFO(StormByte::BinaryData&& data) noexcept : FIFO(std::move(data)) {}
 
            template<StormByte::Type::ByteInputRange R>
            requires (!StormByte::Type::SameAs<R, StormByte::BinaryData>)
            inline SharedFIFO(const R& r) noexcept : FIFO(r) {}
 
            template<StormByte::Type::ByteInputRange Rr>
            inline SharedFIFO(Rr&& r) noexcept : FIFO(std::forward<Rr>(r)) {}
 
            inline SharedFIFO(std::string_view sv) noexcept : FIFO(sv) {}
 
            inline SharedFIFO(const char* s) noexcept : FIFO(s) {}
 
            inline SharedFIFO(const FIFO& other) : FIFO(other) {}
 
            inline SharedFIFO(FIFO&& other) noexcept : FIFO(std::move(other)) {}
 
            SharedFIFO(const SharedFIFO&) = delete;
 
            SharedFIFO(SharedFIFO&&) = delete;
 
            virtual ~SharedFIFO() noexcept;
 
            SharedFIFO& operator=(const FIFO& other);
 
            SharedFIFO& operator=(FIFO&& other) noexcept;
 
            SharedFIFO& operator=(const SharedFIFO&) = delete;
 
            SharedFIFO& operator=(SharedFIFO&&) = delete;
 
            bool operator==(const SharedFIFO& other) const noexcept;
 
            inline bool operator!=(const SharedFIFO& other) const noexcept {
                return !(*this == other);
            }
 
            virtual StormByte::ByteSize Available() const noexcept override;
 
            virtual const StormByte::BinaryData& Data() const noexcept override;
 
            virtual bool Empty() const noexcept override;
 
            virtual bool EoF() const noexcept override;
 
            bool HasError() const noexcept;
 
            virtual bool IsReadable() const noexcept override;
 
            virtual bool IsWritable() const noexcept override;
 
            virtual StormByte::ByteSize Size() const noexcept override;
 
            void Clean() noexcept override;
 
            virtual void Clear() noexcept override;
 
            virtual void Close() noexcept override;
 
            virtual bool Drop(const StormByte::ByteSize& count) noexcept override;
 
            virtual void Seek(const std::ptrdiff_t& offset, const Position& mode) const noexcept override;
 
            virtual void SetError() noexcept override;
 
            virtual StormByte::String::String HexDump(const StormByte::ByteSize& columns = 0,
                                        const StormByte::ByteSize& byte_limit = 0) const noexcept override;
 
        protected:
            // Closed/error state is owned by the base FIFO class.
            // SharedFIFO only protects access and notifies waiters.
 
        private:
            mutable std::mutex m_mutex;                 
            mutable std::condition_variable_any m_cv;   
 
            std::ostringstream HexDumpHeader() const noexcept override;
 
            virtual bool ReadInternal(const StormByte::ByteSize& count, StormByte::BinaryData& outBuffer,
                                    const Operation& flag) noexcept override;
 
            virtual bool ReadInternal(const StormByte::ByteSize& count, WriteOnly& outBuffer,
                                    const Operation& flag) noexcept override;
 
            void Wait(const StormByte::ByteSize& n, std::unique_lock<std::mutex>& lock) const;
 
            virtual bool WriteInternal(const StormByte::ByteSize& count, const StormByte::BinaryData& src) noexcept override;
 
            virtual bool WriteInternal(const StormByte::ByteSize& count, StormByte::BinaryData&& src) noexcept override;
    };
}