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

Cumulative telemetry owned by one Client instance. More...

#include <StormByte/network/client_telemetry.hxx>

Inheritance diagram for StormByte::Network::ClientTelemetry:
Collaboration diagram for StormByte::Network::ClientTelemetry:

Public Member Functions

 ClientTelemetry () noexcept
 Construct all client counters at zero.
 ~ClientTelemetry () noexcept override
 Virtual destructor anchors client telemetry RTTI in Network.
Size ConnectionAttempts () const noexcept
 Number of calls to Client::Connect.
Size ConnectionsEstablished () const noexcept
 Successful connections made by this Client.
Size ConnectionFailures () const noexcept
 Failed connection attempts made by this Client.
bool Connected () const noexcept
 Whether this Client currently has an application connection.
Size Requests () const noexcept
 Requests initiated through Client::Send.
Size Responses () const noexcept
 Requests that returned a decoded response packet.
Size RequestsWithoutResponse () const noexcept
 Requests for which Send returned no decoded response.
Size RequestLatencySamples () const noexcept
 Number of completed request-latency samples.
std::chrono::microseconds MeanRequestLatency () const noexcept
 Mean complete Send round-trip, or zero without samples.
 operator StormByte::Safe::String () const override
 Flatten this client's counters to owned UTF-8 text.
Public Member Functions inherited from StormByte::Network::Telemetry
 ~Telemetry () noexcept override
 Virtual destructor anchors telemetry RTTI in Network.
Public Member Functions inherited from StormByte::Telemetry
virtual operator Safe::String () const=0
STORMBYTE_FORCE_INLINE operator std::string () const

Friends

class Client
 Allow the owning client to record telemetry events.

Additional Inherited Members

Protected Types inherited from StormByte::Network::Telemetry
using Sample = StormByte::Clock::Sample
 Base-owned independent RAII measurement token.
Protected Member Functions inherited from StormByte::Network::Telemetry
 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

Cumulative telemetry owned by one Client instance.

Constructor & Destructor Documentation

◆ ClientTelemetry()

StormByte::Network::ClientTelemetry::ClientTelemetry ( )
noexcept

Construct all client counters at zero.

◆ ~ClientTelemetry()

StormByte::Network::ClientTelemetry::~ClientTelemetry ( )
overridenoexcept

Virtual destructor anchors client telemetry RTTI in Network.

Member Function Documentation

◆ Connected()

bool StormByte::Network::ClientTelemetry::Connected ( ) const
noexcept

Whether this Client currently has an application connection.

Returns
True when the recorded application connection is active.

◆ ConnectionAttempts()

Size StormByte::Network::ClientTelemetry::ConnectionAttempts ( ) const
noexcept

Number of calls to Client::Connect.

Returns
Cumulative connection-attempt count.

◆ ConnectionFailures()

Size StormByte::Network::ClientTelemetry::ConnectionFailures ( ) const
noexcept

Failed connection attempts made by this Client.

Returns
Cumulative failed-connection count.

◆ ConnectionsEstablished()

Size StormByte::Network::ClientTelemetry::ConnectionsEstablished ( ) const
noexcept

Successful connections made by this Client.

Returns
Cumulative successful-connection count.

◆ MeanRequestLatency()

std::chrono::microseconds StormByte::Network::ClientTelemetry::MeanRequestLatency ( ) const
noexcept

Mean complete Send round-trip, or zero without samples.

Returns
Mean elapsed microseconds, truncated to whole microseconds; zero when no samples have been recorded.

◆ operator StormByte::Safe::String()

StormByte::Network::ClientTelemetry::operator StormByte::Safe::String ( ) const
overridevirtual

Flatten this client's counters to owned UTF-8 text.

Returns
Owned text containing the client's telemetry counters.

Implements StormByte::Network::Telemetry.

◆ RequestLatencySamples()

Size StormByte::Network::ClientTelemetry::RequestLatencySamples ( ) const
noexcept

Number of completed request-latency samples.

Returns
Cumulative completed round-trip sample count.

◆ Requests()

Size StormByte::Network::ClientTelemetry::Requests ( ) const
noexcept

Requests initiated through Client::Send.

Returns
Cumulative request-attempt count.

◆ RequestsWithoutResponse()

Size StormByte::Network::ClientTelemetry::RequestsWithoutResponse ( ) const
noexcept

Requests for which Send returned no decoded response.

Returns
Cumulative count of requests without decoded responses.

◆ Responses()

Size StormByte::Network::ClientTelemetry::Responses ( ) const
noexcept

Requests that returned a decoded response packet.

Returns
Cumulative decoded-response count.

◆ Client

friend class Client
friend

Allow the owning client to record telemetry events.


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