NFD: Named Data Networking Forwarding Daemon 24.07-28-gdcc0e6e0
Loading...
Searching...
No Matches
status-report.hpp
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#ifndef NFD_TOOLS_NFDC_STATUS_REPORT_HPP
27#define NFD_TOOLS_NFDC_STATUS_REPORT_HPP
28
29#include "core/common.hpp"
30#include "module.hpp"
31
32#include <ndn-cxx/face.hpp>
33#include <ndn-cxx/security/key-chain.hpp>
34#include <ndn-cxx/security/validator.hpp>
35
36namespace nfd::tools::nfdc {
37
38enum class ReportFormat {
39 XML = 1,
40 TEXT = 2,
41};
42
43std::ostream&
44operator<<(std::ostream& os, ReportFormat fmt);
45
49class StatusReport : boost::noncopyable
50{
51public:
52#ifdef NFD_WITH_TESTS
53 virtual
54 ~StatusReport() = default;
55#endif
56
64 uint32_t
65 collect(ndn::Face& face, ndn::KeyChain& keyChain, ndn::security::Validator& validator,
66 const CommandOptions& options);
67
72 void
73 formatXml(std::ostream& os) const;
74
79 void
80 formatText(std::ostream& os) const;
81
82private:
84 processEvents(ndn::Face& face);
85
86public:
90 std::vector<unique_ptr<Module>> sections;
91};
92
93} // namespace nfd::tools::nfdc
94
95#endif // NFD_TOOLS_NFDC_STATUS_REPORT_HPP
Collects and prints NFD status report.
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.
#define NFD_VIRTUAL_WITH_TESTS
Definition common.hpp:39
std::ostream & operator<<(std::ostream &os, ArgValueType vt)