StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Network::Telemetry Class Referenceabstract

Base for per-client and aggregate server telemetry snapshots. More...

#include <StormByte/network/telemetry.hxx>

Inheritance diagram for StormByte::Network::Telemetry:
Collaboration diagram for StormByte::Network::Telemetry:

Public Member Functions

 ~Telemetry () noexcept override
 Virtual destructor anchors telemetry RTTI in Network.
virtual operator StormByte::Safe::String () const override=0
 Flatten this snapshot to owned UTF-8 text.
Public Member Functions inherited from StormByte::Telemetry
virtual operator Safe::String () const=0
STORMBYTE_FORCE_INLINE operator std::string () const

Protected Types

using Sample = StormByte::Clock::Sample
 Base-owned independent RAII measurement token.

Protected Member Functions

 Telemetry () noexcept
 Construct an empty Network telemetry base.
Sample Measure (std::string_view name) noexcept
 Start a named operation sample.
Protected Member Functions inherited from StormByte::Telemetry
 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)
class Clock::Sample MeasureClock (std::string_view name) noexcept
const class Clock & Clock (std::string_view name) const

Detailed Description

Base for per-client and aggregate server telemetry snapshots.

Timed operations use independent Base samples sharing named clocks. Concurrent and nested operations keep their own start times.

Member Typedef Documentation

◆ Sample

Base-owned independent RAII measurement token.

Samples may overlap, nest or move between threads. Stop is idempotent; destruction records an active sample.

Constructor & Destructor Documentation

◆ ~Telemetry()

StormByte::Network::Telemetry::~Telemetry ( )
overridevirtualnoexcept

Virtual destructor anchors telemetry RTTI in Network.

Reimplemented from StormByte::Telemetry.

◆ Telemetry()

StormByte::Network::Telemetry::Telemetry ( )
protectednoexcept

Construct an empty Network telemetry base.

Member Function Documentation

◆ Measure()

Sample StormByte::Network::Telemetry::Measure ( std::string_view name)
protectednoexcept

Start a named operation sample.

Parameters
nameStable operation label.
Returns
Scoped Base-clock sample.

◆ operator StormByte::Safe::String()

virtual StormByte::Network::Telemetry::operator StormByte::Safe::String ( ) const
overridepure virtual

Flatten this snapshot to owned UTF-8 text.

Returns
Telemetry text.

Implemented in StormByte::Network::ClientTelemetry, and StormByte::Network::ServerTelemetry.


The documentation for this class was generated from the following file: