NFD: Named Data Networking Forwarding Daemon 24.07-28-gdcc0e6e0
Loading...
Searching...
No Matches
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-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_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#include <ndn-cxx/mgmt/nfd/strategy-choice.hpp>
33
34namespace nfd::tools::nfdc {
35
36using ndn::nfd::StrategyChoice;
37
42class StrategyChoiceModule : public Module, boost::noncopyable
43{
44public:
47 static void
49
52 static void
53 list(ExecuteContext& ctx);
54
57 static void
58 show(ExecuteContext& ctx);
59
62 static void
63 set(ExecuteContext& ctx);
64
67 static void
69
70 void
71 fetchStatus(ndn::nfd::Controller& controller,
72 const std::function<void()>& onSuccess,
73 const ndn::nfd::DatasetFailureCallback& onFailure,
74 const CommandOptions& options) override;
75
76 void
77 formatStatusXml(std::ostream& os) const override;
78
83 void
84 formatItemXml(std::ostream& os, const StrategyChoice& item) const;
85
86 void
87 formatStatusText(std::ostream& os) const override;
88
94 static void
95 formatItemText(std::ostream& os, const StrategyChoice& item, bool wantMultiLine = false);
96
97private:
98 std::vector<StrategyChoice> m_status;
99};
100
101} // namespace nfd::tools::nfdc
102
103#endif // NFD_TOOLS_NFDC_STRATEGY_CHOICE_MODULE_HPP
Context for command execution.
Provides access to an NFD management module.
Definition module.hpp:44
Provides access to NFD Strategy Choice management.
static void registerCommands(CommandParser &parser)
Register 'strategy list', 'strategy show', 'strategy set', 'strategy unset' commands.
static void set(ExecuteContext &ctx)
The 'strategy set' command.
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 formatStatusXml(std::ostream &os) const override
Format collected status as XML.
static void unset(ExecuteContext &ctx)
The 'strategy unset' command.
void formatItemXml(std::ostream &os, const StrategyChoice &item) const
Format a single status item as XML.
static void list(ExecuteContext &ctx)
The 'strategy list' command.
static void show(ExecuteContext &ctx)
The 'strategy show' command.
static void formatItemText(std::ostream &os, const StrategyChoice &item, bool wantMultiLine=false)
Format a single status item as text.
void formatStatusText(std::ostream &os) const override
Format collected status as text.