forwarder-general-module.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2023, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
27 #include "format-helpers.hpp"
28 
29 #include <ndn-cxx/mgmt/nfd/status-dataset.hpp>
30 #include <ndn-cxx/util/indented-stream.hpp>
31 
32 namespace nfd::tools::nfdc {
33 
34 void
35 ForwarderGeneralModule::fetchStatus(ndn::nfd::Controller& controller,
36  const std::function<void()>& onSuccess,
37  const ndn::nfd::DatasetFailureCallback& onFailure,
38  const CommandOptions& options)
39 {
40  controller.fetch<ndn::nfd::ForwarderGeneralStatusDataset>(
41  [this, onSuccess] (const ForwarderStatus& result) {
42  m_status = result;
43  onSuccess();
44  },
45  onFailure, options);
46 }
47 
48 static auto
49 calculateUptime(const ForwarderStatus& status)
50 {
51  return status.getCurrentTimestamp() - status.getStartTimestamp();
52 }
53 
54 void
56 {
57  formatItemXml(os, m_status);
58 }
59 
60 void
61 ForwarderGeneralModule::formatItemXml(std::ostream& os, const ForwarderStatus& item)
62 {
63  os << "<generalStatus>";
64 
65  os << "<version>" << xml::Text{item.getNfdVersion()} << "</version>";
66  os << "<startTime>" << xml::formatTimestamp(item.getStartTimestamp()) << "</startTime>";
67  os << "<currentTime>" << xml::formatTimestamp(item.getCurrentTimestamp()) << "</currentTime>";
68  os << "<uptime>" << xml::formatDuration(time::duration_cast<time::seconds>(calculateUptime(item)))
69  << "</uptime>";
70 
71  os << "<nNameTreeEntries>" << item.getNNameTreeEntries() << "</nNameTreeEntries>";
72  os << "<nFibEntries>" << item.getNFibEntries() << "</nFibEntries>";
73  os << "<nPitEntries>" << item.getNPitEntries() << "</nPitEntries>";
74  os << "<nMeasurementsEntries>" << item.getNMeasurementsEntries() << "</nMeasurementsEntries>";
75  os << "<nCsEntries>" << item.getNCsEntries() << "</nCsEntries>";
76 
77  os << "<packetCounters>";
78  os << "<incomingPackets>"
79  << "<nInterests>" << item.getNInInterests() << "</nInterests>"
80  << "<nData>" << item.getNInData() << "</nData>"
81  << "<nNacks>" << item.getNInNacks() << "</nNacks>"
82  << "</incomingPackets>";
83  os << "<outgoingPackets>"
84  << "<nInterests>" << item.getNOutInterests() << "</nInterests>"
85  << "<nData>" << item.getNOutData() << "</nData>"
86  << "<nNacks>" << item.getNOutNacks() << "</nNacks>"
87  << "</outgoingPackets>";
88  os << "</packetCounters>";
89 
90  os << "<nSatisfiedInterests>" << item.getNSatisfiedInterests() << "</nSatisfiedInterests>";
91  os << "<nUnsatisfiedInterests>" << item.getNUnsatisfiedInterests() << "</nUnsatisfiedInterests>";
92 
93  os << "</generalStatus>";
94 }
95 
96 void
98 {
99  os << "General NFD status:\n";
100  ndn::util::IndentedStream indented(os, " ");
101  formatItemText(indented, m_status);
102 }
103 
104 void
105 ForwarderGeneralModule::formatItemText(std::ostream& os, const ForwarderStatus& item)
106 {
107  text::ItemAttributes ia(true, 21);
108 
109  os << ia("version") << item.getNfdVersion()
110  << ia("startTime") << text::formatTimestamp(item.getStartTimestamp())
111  << ia("currentTime") << text::formatTimestamp(item.getCurrentTimestamp())
112  << ia("uptime") << text::formatDuration<time::seconds>(calculateUptime(item), true);
113 
114  os << ia("nNameTreeEntries") << item.getNNameTreeEntries()
115  << ia("nFibEntries") << item.getNFibEntries()
116  << ia("nPitEntries") << item.getNPitEntries()
117  << ia("nMeasurementsEntries") << item.getNMeasurementsEntries()
118  << ia("nCsEntries") << item.getNCsEntries();
119 
120  os << ia("nInInterests") << item.getNInInterests()
121  << ia("nOutInterests") << item.getNOutInterests()
122  << ia("nInData") << item.getNInData()
123  << ia("nOutData") << item.getNOutData()
124  << ia("nInNacks") << item.getNInNacks()
125  << ia("nOutNacks") << item.getNOutNacks()
126  << ia("nSatisfiedInterests") << item.getNSatisfiedInterests()
127  << ia("nUnsatisfiedInterests") << item.getNUnsatisfiedInterests();
128 
129  os << ia.end();
130 }
131 
132 } // namespace nfd::tools::nfdc
void fetchStatus(ndn::nfd::Controller &controller, const std::function< void()> &onSuccess, const ndn::nfd::DatasetFailureCallback &onFailure, const CommandOptions &options) override
Collect status from NFD.
static void formatItemXml(std::ostream &os, const ForwarderStatus &item)
Format a single status item as XML.
void formatStatusXml(std::ostream &os) const override
Format collected status as XML.
void formatStatusText(std::ostream &os) const override
Format collected status as text.
static void formatItemText(std::ostream &os, const ForwarderStatus &item)
Format a single status item as text.
Print attributes of an item.
std::string formatTimestamp(time::system_clock::time_point t)
std::string formatTimestamp(time::system_clock::time_point t)
std::string formatDuration(time::nanoseconds d)
static auto calculateUptime(const ForwarderStatus &status)