strategy-choice-manager.cpp
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 
27 
28 #include "common/logger.hpp"
30 
31 #include <ndn-cxx/mgmt/nfd/strategy-choice.hpp>
32 
33 #include <boost/lexical_cast.hpp>
34 
35 namespace nfd {
36 
37 NFD_LOG_INIT(StrategyChoiceManager);
38 
40  Dispatcher& dispatcher,
41  CommandAuthenticator& authenticator)
42  : ManagerBase("strategy-choice", dispatcher, authenticator)
43  , m_table(strategyChoice)
44 {
45  registerCommandHandler<ndn::nfd::StrategyChoiceSetCommand>("set",
46  [this] (auto&&, auto&&, auto&&, auto&&... args) { setStrategy(std::forward<decltype(args)>(args)...); });
47  registerCommandHandler<ndn::nfd::StrategyChoiceUnsetCommand>("unset",
48  [this] (auto&&, auto&&, auto&&, auto&&... args) { unsetStrategy(std::forward<decltype(args)>(args)...); });
50  [this] (auto&&, auto&&, auto&&... args) { listChoices(std::forward<decltype(args)>(args)...); });
51 }
52 
53 void
54 StrategyChoiceManager::setStrategy(ControlParameters parameters,
55  const ndn::mgmt::CommandContinuation& done)
56 {
57  const Name& prefix = parameters.getName();
58  const Name& strategy = parameters.getStrategy();
59 
60  StrategyChoice::InsertResult res = m_table.insert(prefix, strategy);
61  if (!res) {
62  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): cannot-create " << res);
63  return done(ControlResponse(res.getStatusCode(), boost::lexical_cast<std::string>(res)));
64  }
65 
66  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): OK");
67  auto [hasEntry, instanceName] = m_table.get(prefix);
68  BOOST_ASSERT_MSG(hasEntry, "StrategyChoice entry must exist after StrategyChoice::insert");
69  parameters.setStrategy(instanceName);
70  return done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
71 }
72 
73 void
74 StrategyChoiceManager::unsetStrategy(ControlParameters parameters,
75  const ndn::mgmt::CommandContinuation& done)
76 {
77  const Name& prefix = parameters.getName();
78  // no need to test for ndn:/ , parameter validation takes care of that
79 
80  m_table.erase(parameters.getName());
81 
82  NFD_LOG_DEBUG("strategy-choice/unset(" << prefix << "): OK");
83  done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
84 }
85 
86 void
87 StrategyChoiceManager::listChoices(ndn::mgmt::StatusDatasetContext& context)
88 {
89  for (const auto& i : m_table) {
90  ndn::nfd::StrategyChoice entry;
91  entry.setName(i.getPrefix())
92  .setStrategy(i.getStrategyInstanceName());
93  context.append(entry.wireEncode());
94  }
95  context.end();
96 }
97 
98 } // namespace nfd
Provides ControlCommand authorization according to NFD's configuration file.
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
StrategyChoiceManager(strategy_choice::StrategyChoice &table, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
int getStatusCode() const
Get a status code for use in management command response.
Represents the Strategy Choice table.
void erase(const Name &prefix)
Make prefix to inherit strategy from its parent.
InsertResult insert(const Name &prefix, const Name &strategyName)
Set strategy of prefix to be strategyName.
std::pair< bool, Name > get(const Name &prefix) const
Get strategy Name of prefix.
#define NFD_LOG_INIT(name)
Definition: logger.hpp:31
#define NFD_LOG_DEBUG
Definition: logger.hpp:38
-status-http-server
Definition: common.hpp:71