bridge.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/buffer/generic.hxx>
#include <StormByte/buffer/io/buffered_reader.hxx>
#include <StormByte/buffer/io/buffered_writer.hxx>
#include <StormByte/buffer/telemetry.hxx>
#include <StormByte/buffer/visibility.h>
#include <StormByte/safe_pointers.hxx>
#include <StormByte/type_traits.hxx>
 
#include <memory>
#include <mutex>
#include <utility>
 
namespace StormByte {
    namespace Buffer {
        class ExternalBufferReader;
        class ExternalBufferWriter;
 
        struct STORMBYTE_BUFFER_PUBLIC ExternalReaderDeleter {
            void operator()(ExternalBufferReader* ptr) const noexcept;
        };
 
        struct STORMBYTE_BUFFER_PUBLIC ExternalWriterDeleter {
            void operator()(ExternalBufferWriter* ptr) const noexcept;
        };
 
        class STORMBYTE_BUFFER_PUBLIC Bridge {
            public:
                enum class Operation {
                    Blocking,       
                    NonBlocking     
                };
 
                enum class State {
                    Open,       
                    Closed,     
                    Failed      
                };
 
                Bridge(ReadOnly& in, WriteOnly& out) noexcept;
 
                template<typename In, typename Out>
                STORMBYTE_FORCE_INLINE Bridge(In&& in, Out&& out) noexcept
                    requires (Type::DerivedFrom<std::remove_cvref_t<In>, IO::BufferedReader>
                        && Type::DerivedFrom<std::remove_cvref_t<Out>, IO::BufferedWriter>) {
                    AttachIoIn(std::forward<In>(in));
                    AttachIoOut(std::forward<Out>(out));
                }
 
                template<typename Out>
                STORMBYTE_FORCE_INLINE Bridge(ReadOnly& in, Out&& out) noexcept
                    requires Type::DerivedFrom<std::remove_cvref_t<Out>, IO::BufferedWriter> {
                    AttachIoOut(std::forward<Out>(out));
                    AttachNonIoIn(in);
                }
 
                template<typename In>
                STORMBYTE_FORCE_INLINE Bridge(In&& in, WriteOnly& out) noexcept
                    requires Type::DerivedFrom<std::remove_cvref_t<In>, IO::BufferedReader> {
                    AttachIoIn(std::forward<In>(in));
                    AttachNonIoOut(out);
                }
 
                Bridge(const Bridge&) = delete;
 
                Bridge(Bridge&& other) noexcept;
 
                ~Bridge() noexcept;
 
                Bridge& operator=(const Bridge&) = delete;
 
                Bridge& operator=(Bridge&& other) noexcept;
 
                void Close() noexcept;
 
                bool EoF() const noexcept;
 
                bool Failed() const noexcept;
 
                bool InputIsIO() const noexcept;
 
                bool InputPullBlocking() const noexcept;
 
                enum State State() const noexcept;
 
                StormByte::ByteSize Passthrough(StormByte::ByteSize n,
                    Operation operation = Operation::Blocking);
 
                const StormByte::Shared<StormByte::Buffer::ReadTelemetry> ReadTelemetry() const noexcept;
 
                const StormByte::Shared<StormByte::Buffer::WriteTelemetry> WriteTelemetry() const noexcept;
 
            private:
                void AttachNonIoIn(ReadOnly& in) noexcept;
 
                void AttachNonIoOut(WriteOnly& out) noexcept;
 
                void CacheReadTelemetry() noexcept;
 
                void CacheWriteTelemetry() noexcept;
 
                void ReleaseTips() noexcept;
 
                bool SourceEoF() const noexcept;
 
                IO::Result Pull(StormByte::ByteSize n, FIFO& dest, Operation operation);
 
                IO::Result Push(FIFO& src);
 
                template<typename In>
                STORMBYTE_FORCE_INLINE void AttachIoIn(In&& in) noexcept {
                    m_io_in_blocking = (in.ReadAhead() == StormByte::ByteSize{0});
                    m_io_in = StormByte::Unique<IO::BufferedReader>::MakePointer<std::remove_cvref_t<In>>(
                        std::forward<In>(in));
                    CacheReadTelemetry();
                }
 
                template<typename Out>
                STORMBYTE_FORCE_INLINE void AttachIoOut(Out&& out) noexcept {
                    m_io_out = StormByte::Unique<IO::BufferedWriter>::MakePointer<std::remove_cvref_t<Out>>(
                        std::forward<Out>(out));
                    CacheWriteTelemetry();
                }
 
                std::unique_ptr<ExternalBufferReader, ExternalReaderDeleter> m_ext_in;  
                std::unique_ptr<ExternalBufferWriter, ExternalWriterDeleter> m_ext_out; 
                StormByte::Unique<IO::BufferedReader> m_io_in;                          
                StormByte::Unique<IO::BufferedWriter> m_io_out;                         
                StormByte::Shared<StormByte::Buffer::ReadTelemetry> m_owned_read;       
                StormByte::Shared<StormByte::Buffer::WriteTelemetry> m_owned_write;     
                bool m_io_in_blocking {false};                                          
                enum State m_state {State::Open};                                       
                mutable std::mutex m_mutex;                                             
        };
    }
}