blob: e335aae8af201eb35fefaaaec35ab54bfa7425ae [file] [log] [blame]
Eric Newberry4164b8e2015-04-23 17:29:18 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesaventof8d9a532021-07-03 16:04:12 -04002/*
Davide Pesavento5748e822024-01-26 18:40:22 -05003 * Copyright (c) 2015-2024, Arizona Board of Regents.
Eric Newberry4164b8e2015-04-23 17:29:18 -07004 *
5 * This file is part of ndn-tools (Named Data Networking Essential Tools).
6 * See AUTHORS.md for complete list of ndn-tools authors and contributors.
7 *
8 * ndn-tools is free software: you can redistribute it and/or modify it under the terms
9 * of the GNU General Public License as published by the Free Software Foundation,
10 * either version 3 of the License, or (at your option) any later version.
11 *
12 * ndn-tools is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
13 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along with
17 * ndn-tools, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
18 *
Davide Pesaventof8d9a532021-07-03 16:04:12 -040019 * @author Eric Newberry <enewberry@email.arizona.edu>
20 * @author Jerald Paul Abraham <jeraldabraham@email.arizona.edu>
21 * @author Teng Liang <philoliang@email.arizona.edu>
Eric Newberry4164b8e2015-04-23 17:29:18 -070022 */
23
24#ifndef NDN_TOOLS_PING_CLIENT_STATISTICS_COLLECTOR_HPP
25#define NDN_TOOLS_PING_CLIENT_STATISTICS_COLLECTOR_HPP
26
27#include "core/common.hpp"
Eric Newberry4164b8e2015-04-23 17:29:18 -070028#include "ping.hpp"
29
Davide Pesavento5748e822024-01-26 18:40:22 -050030#include <limits>
31
Davide Pesaventob3570c62022-02-19 19:19:00 -050032namespace ndn::ping::client {
Eric Newberry4164b8e2015-04-23 17:29:18 -070033
34/**
35 * @brief statistics data
36 */
37struct Statistics
38{
39 Name prefix; //!< prefix pinged
40 int nSent; //!< number of pings sent
41 int nReceived; //!< number of pings received
Teng Liang62884862016-03-31 18:15:36 -070042 int nNacked; //!< number of nacks received
Davide Pesaventof8d9a532021-07-03 16:04:12 -040043 time::steady_clock::time_point pingStartTime; //!< time pings started
Eric Newberry4164b8e2015-04-23 17:29:18 -070044 double minRtt; //!< minimum round trip time
45 double maxRtt; //!< maximum round trip time
46 double packetLossRate; //!< packet loss rate
Teng Liang62884862016-03-31 18:15:36 -070047 double packetNackedRate; //!< packet nacked rate
Eric Newberry4164b8e2015-04-23 17:29:18 -070048 double sumRtt; //!< sum of round trip times
49 double avgRtt; //!< average round trip time
50 double stdDevRtt; //!< std dev of round trip time
Eric Newberrydce5a532015-05-06 10:46:52 -070051
52 std::ostream&
53 printSummary(std::ostream& os) const;
Davide Pesaventob3570c62022-02-19 19:19:00 -050054
55 friend std::ostream&
56 operator<<(std::ostream& os, const Statistics& statistics);
Eric Newberry4164b8e2015-04-23 17:29:18 -070057};
58
59/**
Alexander Afanasyev1e7a7b22015-08-26 15:35:26 -070060 * @brief Statistics collector from ping client
Eric Newberry4164b8e2015-04-23 17:29:18 -070061 */
62class StatisticsCollector : noncopyable
63{
64public:
65 /**
66 * @param ping NDN ping client
67 * @param options ping client options
68 */
69 StatisticsCollector(Ping& ping, const Options& options);
70
71 /**
Davide Pesaventof8d9a532021-07-03 16:04:12 -040072 * @brief Compute and return ping statistics as structure
Junxiao Shi2713a3b2015-06-22 16:19:05 -070073 */
Davide Pesaventob3570c62022-02-19 19:19:00 -050074 [[nodiscard]] Statistics
Davide Pesaventof8d9a532021-07-03 16:04:12 -040075 computeStatistics() const;
Junxiao Shi2713a3b2015-06-22 16:19:05 -070076
77PUBLIC_WITH_TESTS_ELSE_PRIVATE:
78 /**
Teng Liang62884862016-03-31 18:15:36 -070079 * @brief Called when a Data packet is received
Eric Newberry4164b8e2015-04-23 17:29:18 -070080 */
81 void
Teng Liang62884862016-03-31 18:15:36 -070082 recordData(Rtt rtt);
83
84 /**
85 * @brief Called when a Nack is received
86 */
87 void
88 recordNack();
Eric Newberry4164b8e2015-04-23 17:29:18 -070089
90 /**
Alexander Afanasyev1e7a7b22015-08-26 15:35:26 -070091 * @brief Called on ping timeout
Eric Newberry4164b8e2015-04-23 17:29:18 -070092 */
93 void
94 recordTimeout();
95
Eric Newberry4164b8e2015-04-23 17:29:18 -070096private:
97 Ping& m_ping;
98 const Options& m_options;
Davide Pesaventob3570c62022-02-19 19:19:00 -050099 time::steady_clock::time_point m_pingStartTime = time::steady_clock::now();
100 int m_nSent = 0;
101 int m_nReceived = 0;
102 int m_nNacked = 0;
103 double m_minRtt = std::numeric_limits<double>::max();
104 double m_maxRtt = 0.0;
105 double m_sumRtt = 0.0;
106 double m_sumRttSquared = 0.0;
Eric Newberry4164b8e2015-04-23 17:29:18 -0700107};
108
Davide Pesaventob3570c62022-02-19 19:19:00 -0500109} // namespace ndn::ping::client
Eric Newberry4164b8e2015-04-23 17:29:18 -0700110
111#endif // NDN_TOOLS_PING_CLIENT_STATISTICS_COLLECTOR_HPP