telemetry.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/telemetry.hxx>
 
#include <chrono>
#include <cstddef>
 
namespace StormByte {
    namespace Buffer {
        namespace Backend {
            namespace IO {
                class BufferedReader;
                class BufferedWriter;
            }
        }
 
        namespace IO {
            class STORMBYTE_BUFFER_PUBLIC ReadTelemetry: public StormByte::Buffer::ReadTelemetry {
                public:
                    ReadTelemetry() noexcept;
 
                    ReadTelemetry(const ReadTelemetry&) = delete;
 
                    ReadTelemetry(ReadTelemetry&&) = delete;
 
                    virtual ~ReadTelemetry() noexcept override;
 
                    ReadTelemetry& operator=(const ReadTelemetry&) = delete;
 
                    ReadTelemetry& operator=(ReadTelemetry&&) = delete;
 
                    StormByte::ByteSize HitAhead() const noexcept;
 
                    StormByte::ByteSize HitBack() const noexcept;
 
                    StormByte::ByteSize Miss() const noexcept;
 
                    StormByte::ByteSize Origin() const noexcept;
 
                    StormByte::ByteSize Cached() const noexcept;
 
                    StormByte::ByteSize CachedPeak() const noexcept;
 
                    StormByte::ByteSize Cap() const noexcept;
 
                    std::size_t SeekLogical() const noexcept;
 
                    std::size_t SeekOrigin() const noexcept;
 
                    std::size_t SeekSavedFull() const noexcept;
 
                    std::size_t SeekSavedPartial() const noexcept;
 
                    std::size_t TryAgain() const noexcept;
 
                    std::size_t Saturated() const noexcept;
 
                    std::size_t Evicted() const noexcept;
 
                    std::chrono::nanoseconds WaitMin() const noexcept;
 
                    std::chrono::nanoseconds WaitMax() const noexcept;
 
                    std::chrono::nanoseconds WaitTotal() const noexcept;
 
                    std::size_t WaitSamples() const noexcept;
 
                    operator StormByte::String::String() const override;
 
                protected:
                    friend class StormByte::Buffer::Backend::IO::BufferedReader;
 
                    StormByte::ByteSize m_hit_ahead;        
                    StormByte::ByteSize m_hit_back;         
                    StormByte::ByteSize m_miss;             
                    StormByte::ByteSize m_origin;           
                    StormByte::ByteSize m_cached;           
                    StormByte::ByteSize m_cached_peak;      
                    StormByte::ByteSize m_cap;              
                    std::size_t m_seek_logical;             
                    std::size_t m_seek_origin;              
                    std::size_t m_seek_saved_full;          
                    std::size_t m_seek_saved_partial;       
                    std::size_t m_try_again;                
                    std::size_t m_saturated;                
                    std::size_t m_evicted;                  
                    std::chrono::nanoseconds m_wait_min;    
                    std::chrono::nanoseconds m_wait_max;    
                    std::chrono::nanoseconds m_wait_total;  
                    std::size_t m_wait_samples;             
            };
 
            class STORMBYTE_BUFFER_PUBLIC WriteTelemetry: public StormByte::Buffer::WriteTelemetry {
                public:
                    WriteTelemetry() noexcept;
 
                    WriteTelemetry(const WriteTelemetry&) = delete;
 
                    WriteTelemetry(WriteTelemetry&&) = delete;
 
                    virtual ~WriteTelemetry() noexcept override;
 
                    WriteTelemetry& operator=(const WriteTelemetry&) = delete;
 
                    WriteTelemetry& operator=(WriteTelemetry&&) = delete;
 
                    StormByte::ByteSize Behind() const noexcept;
 
                    StormByte::ByteSize Direct() const noexcept;
 
                    StormByte::ByteSize Origin() const noexcept;
 
                    StormByte::ByteSize Materialized() const noexcept;
 
                    StormByte::ByteSize HighWater() const noexcept;
 
                    StormByte::ByteSize HitAhead() const noexcept;
 
                    StormByte::ByteSize HitBack() const noexcept;
 
                    StormByte::ByteSize Miss() const noexcept;
 
                    StormByte::ByteSize Dirty() const noexcept;
 
                    StormByte::ByteSize DirtyPeak() const noexcept;
 
                    StormByte::ByteSize Cap() const noexcept;
 
                    std::size_t SeekLogical() const noexcept;
 
                    std::size_t SeekOrigin() const noexcept;
 
                    std::size_t SeekSavedFull() const noexcept;
 
                    std::size_t SeekSavedPartial() const noexcept;
 
                    std::size_t TryAgain() const noexcept;
 
                    std::size_t Saturated() const noexcept;
 
                    std::size_t Evicted() const noexcept;
 
                    std::chrono::nanoseconds WaitMin() const noexcept;
 
                    std::chrono::nanoseconds WaitMax() const noexcept;
 
                    std::chrono::nanoseconds WaitTotal() const noexcept;
 
                    std::size_t WaitSamples() const noexcept;
 
                    operator StormByte::String::String() const override;
 
                protected:
                    friend class StormByte::Buffer::Backend::IO::BufferedWriter;
 
                    StormByte::ByteSize m_behind;           
                    StormByte::ByteSize m_direct;           
                    StormByte::ByteSize m_origin;           
                    StormByte::ByteSize m_materialized;     
                    StormByte::ByteSize m_high_water;       
                    StormByte::ByteSize m_hit_ahead;        
                    StormByte::ByteSize m_hit_back;         
                    StormByte::ByteSize m_miss;             
                    StormByte::ByteSize m_dirty;            
                    StormByte::ByteSize m_dirty_peak;       
                    StormByte::ByteSize m_cap;              
                    std::size_t m_seek_logical;             
                    std::size_t m_seek_origin;              
                    std::size_t m_seek_saved_full;          
                    std::size_t m_seek_saved_partial;       
                    std::size_t m_try_again;                
                    std::size_t m_saturated;                
                    std::size_t m_evicted;                  
                    std::chrono::nanoseconds m_wait_min;    
                    std::chrono::nanoseconds m_wait_max;    
                    std::chrono::nanoseconds m_wait_total;  
                    std::size_t m_wait_samples;             
            };
        }
    }
}