Cumulative telemetry owned by one Client instance.
More...
#include <StormByte/network/client_telemetry.hxx>
|
| class | Client |
| | Allow the owning client to record telemetry events.
|
Cumulative telemetry owned by one Client instance.
◆ 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.
◆ 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()
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
Allow the owning client to record telemetry events.
The documentation for this class was generated from the following file: