StormByte-Network 4.0.0
C++26 networking module of the StormByte suite
Loading...
Searching...
No Matches
client_telemetry.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Network.
5 *
6 * StormByte-Network original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Network source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, and in particular the bundled StormByte Buffer tree), which
23 * remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Network is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Network. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
45#include <StormByte/safe/atomic.hxx>
46#include <StormByte/size.hxx>
47
48#include <chrono>
49#include <cstdint>
50
55namespace StormByte {
60 namespace Network {
65 class Client;
66
72 public:
76 ClientTelemetry() noexcept;
77
81 ~ClientTelemetry() noexcept override;
82
87 Size ConnectionAttempts() const noexcept;
88
93 Size ConnectionsEstablished() const noexcept;
94
99 Size ConnectionFailures() const noexcept;
100
105 bool Connected() const noexcept;
106
111 Size Requests() const noexcept;
112
117 Size Responses() const noexcept;
118
124
129 Size RequestLatencySamples() const noexcept;
130
136 std::chrono::microseconds MeanRequestLatency() const noexcept;
137
142 operator StormByte::Safe::String() const override;
143
144 private:
148 friend class Client;
149
153 void RecordConnectionAttempt() noexcept;
154
158 void RecordConnectionEstablished() noexcept;
159
163 void RecordConnectionFailed() noexcept;
164
168 void RecordDisconnected() noexcept;
169
173 void RecordRequest() noexcept;
174
182 void RecordRequestResult(std::chrono::microseconds elapsed, bool responded) noexcept;
183
188 Sample MeasureRequest();
189
190 Safe::Atomic<std::uint64_t> m_connection_attempts{0};
191 Safe::Atomic<std::uint64_t> m_connections_established{0};
192 Safe::Atomic<std::uint64_t> m_connection_failures{0};
193 Safe::Atomic<bool> m_connected{false};
194 Safe::Atomic<std::uint64_t> m_requests{0};
195 Safe::Atomic<std::uint64_t> m_responses{0};
196 Safe::Atomic<std::uint64_t> m_requests_without_response{0};
197 Safe::Atomic<std::uint64_t> m_latency_samples{0};
198 Safe::Atomic<std::uint64_t> m_latency_us{0};
199 };
200 }
201}
202
STORMBYTE_DECLARE_MAYBE_SAFE(StormByte::Buffer::Bridge)
Cumulative telemetry owned by one Client instance.
Definition client_telemetry.hxx:71
Size RequestsWithoutResponse() const noexcept
Requests for which Send returned no decoded response.
Size ConnectionFailures() const noexcept
Failed connection attempts made by this Client.
operator StormByte::Safe::String() const override
Flatten this client's counters to owned UTF-8 text.
ClientTelemetry() noexcept
Construct all client counters at zero.
friend class Client
Allow the owning client to record telemetry events.
Definition client_telemetry.hxx:148
Size Requests() const noexcept
Requests initiated through Client::Send.
Size ConnectionsEstablished() const noexcept
Successful connections made by this Client.
std::chrono::microseconds MeanRequestLatency() const noexcept
Mean complete Send round-trip, or zero without samples.
bool Connected() const noexcept
Whether this Client currently has an application connection.
Size ConnectionAttempts() const noexcept
Number of calls to Client::Connect.
Size Responses() const noexcept
Requests that returned a decoded response packet.
Size RequestLatencySamples() const noexcept
Number of completed request-latency samples.
Abstract application client.
Definition client.hxx:124
Telemetry() noexcept
Construct an empty Network telemetry base.
StormByte::Clock::Sample Sample
Base-owned independent RAII measurement token.
Definition telemetry.hxx:91
Network module of the StormByte suite.
Root namespace of the StormByte suite.
STL namespace.
#define STORMBYTE_NETWORK_PUBLIC
Definition visibility.h:51