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-2018, 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_MODULE_HPP
27 #define NFD_TOOLS_NFDC_MODULE_HPP
28 
29 #include "core/common.hpp"
30 #include <ndn-cxx/mgmt/nfd/command-options.hpp>
31 #include <ndn-cxx/mgmt/nfd/controller.hpp>
32 
33 namespace nfd {
34 namespace tools {
35 namespace nfdc {
36 
37 using ndn::nfd::CommandOptions;
38 using ndn::nfd::Controller;
39 
43 class Module
44 {
45 public:
46  virtual
47  ~Module() = default;
48 
56  virtual void
57  fetchStatus(Controller& controller,
58  const std::function<void()>& onSuccess,
59  const Controller::DatasetFailCallback& onFailure,
60  const CommandOptions& options) = 0;
61 
66  virtual void
67  formatStatusXml(std::ostream& os) const = 0;
68 
73  virtual void
74  formatStatusText(std::ostream& os) const = 0;
75 };
76 
77 } // namespace nfdc
78 } // namespace tools
79 } // namespace nfd
80 
81 #endif // NFD_TOOLS_NFDC_MODULE_HPP
virtual void fetchStatus(Controller &controller, const std::function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options)=0
collect status from NFD
virtual void formatStatusXml(std::ostream &os) const =0
format collected status as XML
virtual ~Module()=default
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
virtual void formatStatusText(std::ostream &os) const =0
format collected status as text
provides access to an NFD management module
Definition: module.hpp:43