forwarder-general-module.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2022, 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_FORWARDER_GENERAL_MODULE_HPP
27 #define NFD_TOOLS_NFDC_FORWARDER_GENERAL_MODULE_HPP
28 
29 #include "module.hpp"
30 
31 namespace nfd::tools::nfdc {
32 
33 using ndn::nfd::ForwarderStatus;
34 
38 class ForwarderGeneralModule : public Module, noncopyable
39 {
40 public:
41  void
42  fetchStatus(Controller& controller,
43  const std::function<void()>& onSuccess,
44  const Controller::DatasetFailCallback& onFailure,
45  const CommandOptions& options) override;
46 
47  void
48  formatStatusXml(std::ostream& os) const override;
49 
54  static void
55  formatItemXml(std::ostream& os, const ForwarderStatus& item);
56 
57  void
58  formatStatusText(std::ostream& os) const override;
59 
64  static void
65  formatItemText(std::ostream& os, const ForwarderStatus& item);
66 
67 private:
68  ForwarderStatus m_status;
69 };
70 
71 } // namespace nfd::tools::nfdc
72 
73 #endif // NFD_TOOLS_NFDC_FORWARDER_GENERAL_MODULE_HPP
Provides access to NFD forwarder general status.
void fetchStatus(Controller &controller, const std::function< void()> &onSuccess, const Controller::DatasetFailCallback &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.
Provides access to an NFD management module.
Definition: module.hpp:42