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-2017, 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 namespace nfd {
30 namespace tools {
31 namespace nfdc {
32 
33 void
34 ForwarderGeneralModule::fetchStatus(Controller& controller,
35  const function<void()>& onSuccess,
36  const Controller::DatasetFailCallback& onFailure,
37  const CommandOptions& options)
38 {
39  controller.fetch<ndn::nfd::ForwarderGeneralStatusDataset>(
40  [this, onSuccess] (const ForwarderStatus& result) {
41  m_status = result;
42  onSuccess();
43  },
44  onFailure, options);
45 }
46 
47 static time::system_clock::Duration
48 calculateUptime(const ForwarderStatus& status)
49 {
50  return status.getCurrentTimestamp() - status.getStartTimestamp();
51 }
52 
53 void
55 {
56  this->formatItemXml(os, m_status);
57 }
58 
59 void
60 ForwarderGeneralModule::formatItemXml(std::ostream& os, const ForwarderStatus& item) const
61 {
62  os << "<generalStatus>";
63 
64  os << "<version>" << xml::Text{item.getNfdVersion()} << "</version>";
65  os << "<startTime>" << xml::formatTimestamp(item.getStartTimestamp()) << "</startTime>";
66  os << "<currentTime>" << xml::formatTimestamp(item.getCurrentTimestamp()) << "</currentTime>";
67  os << "<uptime>" << xml::formatDuration(calculateUptime(item)) << "</uptime>";
68 
69  os << "<nNameTreeEntries>" << item.getNNameTreeEntries() << "</nNameTreeEntries>";
70  os << "<nFibEntries>" << item.getNFibEntries() << "</nFibEntries>";
71  os << "<nPitEntries>" << item.getNPitEntries() << "</nPitEntries>";
72  os << "<nMeasurementsEntries>" << item.getNMeasurementsEntries() << "</nMeasurementsEntries>";
73  os << "<nCsEntries>" << item.getNCsEntries() << "</nCsEntries>";
74 
75  os << "<packetCounters>";
76  os << "<incomingPackets>"
77  << "<nInterests>" << item.getNInInterests() << "</nInterests>"
78  << "<nData>" << item.getNInData() << "</nData>"
79  << "<nNacks>" << item.getNInNacks() << "</nNacks>"
80  << "</incomingPackets>";
81  os << "<outgoingPackets>"
82  << "<nInterests>" << item.getNOutInterests() << "</nInterests>"
83  << "<nData>" << item.getNOutData() << "</nData>"
84  << "<nNacks>" << item.getNOutNacks() << "</nNacks>"
85  << "</outgoingPackets>";
86  os << "</packetCounters>";
87 
88  os << "</generalStatus>";
89 }
90 
91 void
93 {
94  os << "General NFD status:\n";
95  this->formatItemText(os, m_status);
96 }
97 
98 void
99 ForwarderGeneralModule::formatItemText(std::ostream& os, const ForwarderStatus& item) const
100 {
101  os << " version=" << item.getNfdVersion() << "\n";
102  os << " startTime=" << text::formatTimestamp(item.getStartTimestamp()) << "\n";
103  os << " currentTime=" << text::formatTimestamp(item.getCurrentTimestamp()) << "\n";
104  os << " uptime=" << text::formatDuration(calculateUptime(item), true) << "\n";
105 
106  os << " nNameTreeEntries=" << item.getNNameTreeEntries() << "\n";
107  os << " nFibEntries=" << item.getNFibEntries() << "\n";
108  os << " nPitEntries=" << item.getNPitEntries() << "\n";
109  os << " nMeasurementsEntries=" << item.getNMeasurementsEntries() << "\n";
110  os << " nCsEntries=" << item.getNCsEntries() << "\n";
111 
112  os << " nInInterests=" << item.getNInInterests() << "\n";
113  os << " nOutInterests=" << item.getNOutInterests() << "\n";
114  os << " nInData=" << item.getNInData() << "\n";
115  os << " nOutData=" << item.getNOutData() << "\n";
116  os << " nInNacks=" << item.getNInNacks() << "\n";
117  os << " nOutNacks=" << item.getNOutNacks() << "\n";
118 }
119 
120 } // namespace nfdc
121 } // namespace tools
122 } // namespace nfd
void formatItemText(std::ostream &os, const ForwarderStatus &item) const
format a single status item as text
void fetchStatus(Controller &controller, const function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
collect status from NFD
std::string formatTimestamp(time::system_clock::TimePoint t)
std::string formatDuration(DURATION d)
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
std::string formatTimestamp(time::system_clock::TimePoint t)
void formatStatusXml(std::ostream &os) const override
format collected status as XML
void formatItemXml(std::ostream &os, const ForwarderStatus &item) const
format a single status item as XML
static time::system_clock::Duration calculateUptime(const ForwarderStatus &status)
std::string formatDuration(DURATION d, bool isLong=false)
void formatStatusText(std::ostream &os) const override
format collected status as text