status-report.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 
26 #include "status-report.hpp"
27 #include "format-helpers.hpp"
28 
29 namespace nfd::tools::nfdc {
30 
31 std::ostream&
32 operator<<(std::ostream& os, ReportFormat fmt)
33 {
34  switch (fmt) {
35  case ReportFormat::XML:
36  return os << "xml";
37  case ReportFormat::TEXT:
38  return os << "text";
39  }
40  return os << static_cast<int>(fmt);
41 }
42 
43 uint32_t
44 StatusReport::collect(ndn::Face& face, ndn::KeyChain& keyChain, ndn::security::Validator& validator,
45  const CommandOptions& options)
46 {
47  ndn::nfd::Controller controller(face, keyChain, validator);
48  uint32_t errorCode = 0;
49 
50  for (size_t i = 0; i < sections.size(); ++i) {
51  Module& module = *sections[i];
52  module.fetchStatus(
53  controller,
54  []{},
55  [i, &errorCode] (uint32_t code, const std::string& reason) {
56  errorCode = i * 1000000 + code;
57  },
58  options);
59  }
60 
61  this->processEvents(face);
62  return errorCode;
63 }
64 
65 void
66 StatusReport::processEvents(ndn::Face& face)
67 {
68  face.processEvents();
69 }
70 
71 void
72 StatusReport::formatXml(std::ostream& os) const
73 {
74  xml::printHeader(os);
75  for (const auto& module : sections) {
76  module->formatStatusXml(os);
77  }
78  xml::printFooter(os);
79 }
80 
81 void
82 StatusReport::formatText(std::ostream& os) const
83 {
84  for (const auto& module : sections) {
85  module->formatStatusText(os);
86  }
87 }
88 
89 } // namespace nfd::tools::nfdc
Provides access to an NFD management module.
Definition: module.hpp:44
virtual void fetchStatus(ndn::nfd::Controller &controller, const std::function< void()> &onSuccess, const ndn::nfd::DatasetFailureCallback &onFailure, const CommandOptions &options)=0
Collect status from NFD.
void formatText(std::ostream &os) const
Print a text report.
void formatXml(std::ostream &os) const
Print an XML report.
std::vector< unique_ptr< Module > > sections
Modules through which status is collected.
uint32_t collect(ndn::Face &face, ndn::KeyChain &keyChain, ndn::security::Validator &validator, const CommandOptions &options)
Collect status via chosen sections.
void printFooter(std::ostream &os)
void printHeader(std::ostream &os)
std::ostream & operator<<(std::ostream &os, ArgValueType vt)