cs-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_CS_MODULE_HPP
27 #define NFD_TOOLS_NFDC_CS_MODULE_HPP
28 
29 #include "command-parser.hpp"
30 #include "module.hpp"
31 
32 namespace nfd {
33 namespace tools {
34 namespace nfdc {
35 
36 using ndn::nfd::CsInfo;
37 
41 class CsModule : public Module, noncopyable
42 {
43 public:
46  static void
48 
51  static void
52  config(ExecuteContext& ctx);
53 
56  static void
57  erase(ExecuteContext& ctx);
58 
59  void
60  fetchStatus(Controller& controller,
61  const std::function<void()>& onSuccess,
62  const Controller::DatasetFailCallback& onFailure,
63  const CommandOptions& options) override;
64 
65  void
66  formatStatusXml(std::ostream& os) const override;
67 
68  static void
69  formatItemXml(std::ostream& os, const CsInfo& item);
70 
71  void
72  formatStatusText(std::ostream& os) const override;
73 
74  static void
75  formatItemText(std::ostream& os, const CsInfo& item);
76 
77 private:
78  CsInfo m_status;
79 };
80 
81 } // namespace nfdc
82 } // namespace tools
83 } // namespace nfd
84 
85 #endif // NFD_TOOLS_NFDC_CS_MODULE_HPP
static void formatItemXml(std::ostream &os, const CsInfo &item)
Definition: cs-module.cpp:154
context for command execution
void fetchStatus(Controller &controller, const std::function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
collect status from NFD
Definition: cs-module.cpp:134
void formatStatusText(std::ostream &os) const override
format collected status as text
Definition: cs-module.cpp:167
static void config(ExecuteContext &ctx)
the &#39;cs config&#39; command
Definition: cs-module.cpp:55
provides access to NFD CS management
Definition: cs-module.hpp:41
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
void formatStatusXml(std::ostream &os) const override
format collected status as XML
Definition: cs-module.cpp:148
static void formatItemText(std::ostream &os, const CsInfo &item)
Definition: cs-module.cpp:175
static void erase(ExecuteContext &ctx)
the &#39;cs erase&#39; command
Definition: cs-module.cpp:90
static void registerCommands(CommandParser &parser)
register &#39;cs config&#39; command
Definition: cs-module.cpp:36
provides access to an NFD management module
Definition: module.hpp:43