channel-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-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_CHANNEL_MODULE_HPP
27 #define NFD_TOOLS_NFDC_CHANNEL_MODULE_HPP
28 
29 #include "module.hpp"
30 
31 #include <ndn-cxx/mgmt/nfd/channel-status.hpp>
32 
33 namespace nfd::tools::nfdc {
34 
35 using ndn::nfd::ChannelStatus;
36 
41 class ChannelModule : public Module, boost::noncopyable
42 {
43 public:
44  void
45  fetchStatus(ndn::nfd::Controller& controller,
46  const std::function<void()>& onSuccess,
47  const ndn::nfd::DatasetFailureCallback& onFailure,
48  const CommandOptions& options) override;
49 
50  void
51  formatStatusXml(std::ostream& os) const override;
52 
57  void
58  formatItemXml(std::ostream& os, const ChannelStatus& item) const;
59 
60  void
61  formatStatusText(std::ostream& os) const override;
62 
67  void
68  formatItemText(std::ostream& os, const ChannelStatus& item) const;
69 
70 private:
71  std::vector<ChannelStatus> m_status;
72 };
73 
74 } // namespace nfd::tools::nfdc
75 
76 #endif // NFD_TOOLS_NFDC_CHANNEL_MODULE_HPP
Provides access to NFD channel dataset.
void fetchStatus(ndn::nfd::Controller &controller, const std::function< void()> &onSuccess, const ndn::nfd::DatasetFailureCallback &onFailure, const CommandOptions &options) override
Collect status from NFD.
void formatStatusText(std::ostream &os) const override
Format collected status as text.
void formatStatusXml(std::ostream &os) const override
Format collected status as XML.
void formatItemText(std::ostream &os, const ChannelStatus &item) const
Format a single status item as text.
void formatItemXml(std::ostream &os, const ChannelStatus &item) const
Format a single status item as XML.
Provides access to an NFD management module.
Definition: module.hpp:44