strategy-choice-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_STRATEGY_CHOICE_MODULE_HPP
27 #define NFD_TOOLS_NFDC_STRATEGY_CHOICE_MODULE_HPP
28 
29 #include "module.hpp"
30 #include "command-parser.hpp"
31 
32 namespace nfd {
33 namespace tools {
34 namespace nfdc {
35 
36 using ndn::nfd::StrategyChoice;
37 
41 class StrategyChoiceModule : public Module, noncopyable
42 {
43 public:
46  static void
48 
51  static void
52  list(ExecuteContext& ctx);
53 
56  static void
57  show(ExecuteContext& ctx);
58 
61  static void
62  set(ExecuteContext& ctx);
63 
66  static void
67  unset(ExecuteContext& ctx);
68 
69  void
70  fetchStatus(Controller& controller,
71  const std::function<void()>& onSuccess,
72  const Controller::DatasetFailCallback& onFailure,
73  const CommandOptions& options) override;
74 
75  void
76  formatStatusXml(std::ostream& os) const override;
77 
82  void
83  formatItemXml(std::ostream& os, const StrategyChoice& item) const;
84 
85  void
86  formatStatusText(std::ostream& os) const override;
87 
93  static void
94  formatItemText(std::ostream& os, const StrategyChoice& item, bool wantMultiLine = false);
95 
96 private:
97  std::vector<StrategyChoice> m_status;
98 };
99 
100 } // namespace nfdc
101 } // namespace tools
102 } // namespace nfd
103 
104 #endif // NFD_TOOLS_NFDC_STRATEGY_CHOICE_MODULE_HPP
context for command execution
void formatStatusText(std::ostream &os) const override
format collected status as text
static void list(ExecuteContext &ctx)
the &#39;strategy list&#39; command
void fetchStatus(Controller &controller, const std::function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
collect status from NFD
static void registerCommands(CommandParser &parser)
register &#39;strategy list&#39;, &#39;strategy show&#39;, &#39;strategy set&#39;, &#39;strategy unset&#39; commands ...
provides access to NFD Strategy Choice management
static void unset(ExecuteContext &ctx)
the &#39;strategy unset&#39; command
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
void formatItemXml(std::ostream &os, const StrategyChoice &item) const
format a single status item as XML
static void show(ExecuteContext &ctx)
the &#39;strategy show&#39; command
static void formatItemText(std::ostream &os, const StrategyChoice &item, bool wantMultiLine=false)
format a single status item as text
provides access to an NFD management module
Definition: module.hpp:43
void formatStatusXml(std::ostream &os) const override
format collected status as XML