parameters.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/byte_size.hxx>
#include <StormByte/platform.h>
 
#include <chrono>
#include <cstddef>
#include <optional>
#include <utility>
 
namespace StormByte {
    namespace Buffer {
        namespace IO {
            class ReadAhead {
                public:
                    STORMBYTE_FORCE_INLINE explicit ReadAhead(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 MaxMemory {
                public:
                    STORMBYTE_FORCE_INLINE explicit MaxMemory(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 MaxWait {
                public:
                    STORMBYTE_FORCE_INLINE explicit MaxWait(const std::chrono::milliseconds value) noexcept:
                        m_value(value) {}
 
                    STORMBYTE_FORCE_INLINE std::chrono::milliseconds Value() const noexcept {
                        return m_value;
                    }
 
                private:
                    std::chrono::milliseconds m_value;  
            };
 
            class WriteChunk {
                public:
                    STORMBYTE_FORCE_INLINE explicit WriteChunk(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 BackPressure {
                public:
                    STORMBYTE_FORCE_INLINE explicit BackPressure(const std::size_t value) noexcept:
                        m_value(value) {}
 
                    STORMBYTE_FORCE_INLINE std::size_t Value() const noexcept {
                        return m_value;
                    }
 
                private:
                    std::size_t m_value;    
            };
 
            class ReaderParameters {
                public:
                    STORMBYTE_FORCE_INLINE ReaderParameters() noexcept = default;
 
                    template<typename... Knobs>
                    STORMBYTE_FORCE_INLINE ReaderParameters(Knobs... knobs) {
                        (Apply(std::move(knobs)), ...);
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& ReadAhead() const noexcept {
                        return m_read_ahead;
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& MaxMemory() const noexcept {
                        return m_max_memory;
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<std::chrono::milliseconds>& MaxWait() const noexcept {
                        return m_max_wait;
                    }
 
                private:
                    STORMBYTE_FORCE_INLINE void Apply(class ReadAhead knob) noexcept {
                        m_read_ahead = knob.Value();
                    }
 
                    STORMBYTE_FORCE_INLINE void Apply(class MaxMemory knob) noexcept {
                        m_max_memory = knob.Value();
                    }
 
                    STORMBYTE_FORCE_INLINE void Apply(class MaxWait knob) noexcept {
                        m_max_wait = knob.Value();
                    }
 
                    template<typename Knob>
                    void Apply(Knob&&) = delete;
 
                    std::optional<StormByte::ByteSize> m_read_ahead;                
                    std::optional<StormByte::ByteSize> m_max_memory;                
                    std::optional<std::chrono::milliseconds> m_max_wait;            
            };
 
            class WriterParameters {
                public:
                    STORMBYTE_FORCE_INLINE WriterParameters() noexcept = default;
 
                    template<typename... Knobs>
                    STORMBYTE_FORCE_INLINE WriterParameters(Knobs... knobs) {
                        (Apply(std::move(knobs)), ...);
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& WriteChunk() const noexcept {
                        return m_write_chunk;
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<std::size_t>& BackPressure() const noexcept {
                        return m_back_pressure;
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<StormByte::ByteSize>& MaxMemory() const noexcept {
                        return m_max_memory;
                    }
 
                    STORMBYTE_FORCE_INLINE const std::optional<std::chrono::milliseconds>& MaxWait() const noexcept {
                        return m_max_wait;
                    }
 
                private:
                    STORMBYTE_FORCE_INLINE void Apply(class WriteChunk knob) noexcept {
                        m_write_chunk = knob.Value();
                    }
 
                    STORMBYTE_FORCE_INLINE void Apply(class BackPressure knob) noexcept {
                        m_back_pressure = knob.Value();
                    }
 
                    STORMBYTE_FORCE_INLINE void Apply(class MaxMemory knob) noexcept {
                        m_max_memory = knob.Value();
                    }
 
                    STORMBYTE_FORCE_INLINE void Apply(class MaxWait knob) noexcept {
                        m_max_wait = knob.Value();
                    }
 
                    template<typename Knob>
                    void Apply(Knob&&) = delete;
 
                    std::optional<StormByte::ByteSize> m_write_chunk;               
                    std::optional<std::size_t> m_back_pressure;                     
                    std::optional<StormByte::ByteSize> m_max_memory;                
                    std::optional<std::chrono::milliseconds> m_max_wait;            
            };
        }
    }
}