telemetry.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte.
 *
 * StormByte 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 source in this repository.
 * They do not cover other StormByte modules or any third-party material
 * shipped with this repository (including everything under thirdparty/),
 * 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 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. 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/safe/string.hxx>
#include <StormByte/platform.h>
#include <StormByte/safe/pointers.hxx>
#include <StormByte/visibility.h>
 
#include <chrono>
#include <cstdint>
#include <optional>
#include <string>
#include <string_view>
 
namespace StormByte {
    class STORMBYTE_PUBLIC Clock final {
        public:
            Clock() noexcept;
 
            Clock(const Clock&) = delete;
 
            Clock(Clock&&) noexcept;
 
            Clock& operator=(const Clock&) = delete;
 
            Clock& operator=(Clock&&) noexcept;
 
            ~Clock() noexcept;
 
            void Start() noexcept;
 
            void Stop() noexcept;
 
            std::uint64_t Count() const noexcept;
 
            std::chrono::microseconds Time() const noexcept;
 
            std::chrono::microseconds MeanDuration() const noexcept;
 
        private:
            std::optional<std::chrono::steady_clock::time_point> m_start;   
            std::chrono::microseconds m_time;   
            std::uint64_t m_count;  
    };
 
    class STORMBYTE_PUBLIC Telemetry {
        public:
            virtual ~Telemetry() noexcept;
 
            virtual operator Safe::String() const = 0;
 
            STORMBYTE_FORCE_INLINE operator std::string() const {
                return static_cast<std::string>(static_cast<Safe::String>(*this));
            }
 
        protected:
            Telemetry() noexcept;
 
            Telemetry(const Telemetry&) = delete;
 
            Telemetry(Telemetry&& other) noexcept;
 
            Telemetry& operator=(const Telemetry&) = delete;
 
            Telemetry& operator=(Telemetry&& other) noexcept;
 
            class Clock& Clock(std::string_view name) noexcept;
 
            const class Clock& Clock(std::string_view name) const noexcept;
 
        private:
            struct Store;
            Safe::Unique<Store> m_store;    
    };
}