pumper.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/bridge.hxx>
#include <StormByte/buffer/telemetry.hxx>
#include <StormByte/buffer/visibility.h>
#include <StormByte/platform.h>
#include <StormByte/safe_pointers.hxx>
 
#include <memory>
#include <optional>
#include <utility>
 
namespace StormByte {
    namespace Buffer {
        namespace Backend {
            class Pumper;
        }
 
        class Chunk {
            public:
                STORMBYTE_FORCE_INLINE explicit Chunk(const StormByte::ByteSize value) noexcept:
                    m_value(value) {}
 
                STORMBYTE_FORCE_INLINE StormByte::ByteSize Value() const noexcept {
                    return m_value;
                }
 
            private:
                StormByte::ByteSize m_value;    
        };
 
        class HighWater {
            public:
                STORMBYTE_FORCE_INLINE explicit HighWater(const StormByte::ByteSize value) noexcept:
                    m_value(value) {}
 
                STORMBYTE_FORCE_INLINE StormByte::ByteSize Value() const noexcept {
                    return m_value;
                }
 
            private:
                StormByte::ByteSize m_value;    
        };
 
        class STORMBYTE_BUFFER_PUBLIC Pumper {
            public:
                class Parameters {
                    public:
                        STORMBYTE_FORCE_INLINE Parameters() noexcept = default;
 
                        template<typename... Knobs>
                        STORMBYTE_FORCE_INLINE Parameters(Knobs... knobs) {
                            (Apply(std::move(knobs)), ...);
                        }
 
                        STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& Chunk() const noexcept {
                            return m_chunk;
                        }
 
                        STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& HighWater() const noexcept {
                            return m_high_water;
                        }
 
                    private:
                        STORMBYTE_FORCE_INLINE void Apply(class Chunk knob) noexcept {
                            m_chunk = knob.Value();
                        }
 
                        STORMBYTE_FORCE_INLINE void Apply(class HighWater knob) noexcept {
                            m_high_water = knob.Value();
                        }
 
                        template<typename Knob>
                        void Apply(Knob&&) = delete;
 
                        std::optional<StormByte::ByteSize> m_chunk;         
                        std::optional<StormByte::ByteSize> m_high_water;    
                };
 
                STORMBYTE_FORCE_INLINE explicit Pumper(Bridge&& bridge, Parameters parameters = {}):
                    Pumper(std::move(bridge),
                        parameters.Chunk().value_or(StormByte::ByteSize{0}),
                        parameters.HighWater()) {}
 
                Pumper(const Pumper&) = delete;
 
                Pumper(Pumper&& other) noexcept;
 
                ~Pumper() noexcept;
 
                Pumper& operator=(const Pumper&) = delete;
 
                Pumper& operator=(Pumper&& other) noexcept;
 
                void Cancel() noexcept;
 
                bool Canceled() const noexcept;
 
                bool EoF() const noexcept;
 
                bool Failed() const noexcept;
 
                void Toggle() noexcept;
 
                const StormByte::Shared<StormByte::Buffer::ReadTelemetry> ReadTelemetry() const noexcept;
 
                const StormByte::Shared<StormByte::Buffer::WriteTelemetry> WriteTelemetry() const noexcept;
 
            private:
                Pumper(Bridge&& bridge, StormByte::ByteSize chunk,
                    std::optional<StormByte::ByteSize> high_water);
 
                std::unique_ptr<Backend::Pumper> m_backend; 
        };
    }
}