NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2021, 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 
32 
33 namespace nfd {
34 
36 
38  Dispatcher& dispatcher,
39  CommandAuthenticator& authenticator)
40  : ManagerBase("strategy-choice", dispatcher, authenticator)
41  , m_table(strategyChoice)
42 {
43  registerCommandHandler<ndn::nfd::StrategyChoiceSetCommand>("set",
44  std::bind(&StrategyChoiceManager::setStrategy, this, _4, _5));
45  registerCommandHandler<ndn::nfd::StrategyChoiceUnsetCommand>("unset",
46  std::bind(&StrategyChoiceManager::unsetStrategy, this, _4, _5));
47 
49  std::bind(&StrategyChoiceManager::listChoices, this, _3));
50 }
51 
52 void
53 StrategyChoiceManager::setStrategy(ControlParameters parameters,
55 {
56  const Name& prefix = parameters.getName();
57  const Name& strategy = parameters.getStrategy();
58 
59  StrategyChoice::InsertResult res = m_table.insert(prefix, strategy);
60  if (!res) {
61  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): cannot-create " << res);
62  return done(ControlResponse(res.getStatusCode(), boost::lexical_cast<std::string>(res)));
63  }
64 
65  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): OK");
66  bool hasEntry = false;
67  Name instanceName;
68  std::tie(hasEntry, instanceName) = m_table.get(prefix);
69  BOOST_ASSERT_MSG(hasEntry, "StrategyChoice entry must exist after StrategyChoice::insert");
70  parameters.setStrategy(instanceName);
71  return done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
72 }
73 
74 void
75 StrategyChoiceManager::unsetStrategy(ControlParameters parameters,
77 {
78  const Name& prefix = parameters.getName();
79  // no need to test for ndn:/ , parameter validation takes care of that
80 
81  m_table.erase(parameters.getName());
82 
83  NFD_LOG_DEBUG("strategy-choice/unset(" << prefix << "): OK");
84  done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
85 }
86 
87 void
88 StrategyChoiceManager::listChoices(ndn::mgmt::StatusDatasetContext& context)
89 {
90  for (const auto& i : m_table) {
92  entry.setName(i.getPrefix())
93  .setStrategy(i.getStrategyInstanceName());
94  context.append(entry.wireEncode());
95  }
96  context.end();
97 }
98 
99 } // namespace nfd
int getStatusCode() const
Get a status code for use in management command response.
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name & prefix
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
StrategyChoiceManager(strategy_choice::StrategyChoice &table, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
#define NFD_LOG_INIT(name)
Definition: logger.hpp:31
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name const Interest const ControlParameters const ndn::mgmt::CommandContinuation done
represents parameters in a ControlCommand request or response
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:130
Implements the Strategy Choice Management of NFD Management Protocol.
void erase(const Name &prefix)
Make prefix to inherit strategy from its parent.
size_t wireEncode(EncodingImpl< TAG > &encoder) const
std::pair< bool, Name > get(const Name &prefix) const
Get strategy Name of prefix.
ControlParameters & setStrategy(const Name &strategy)
InsertResult insert(const Name &prefix, const Name &strategyName)
Set strategy of prefix to be strategyName.
mgmt::ControlResponse ControlResponse
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
void end()
Finalizes the response successfully after appending zero or more blocks.
#define NFD_LOG_DEBUG
Definition: logger.hpp:38
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Represents an absolute name.
Definition: name.hpp:41
std::function< void(const ControlResponse &resp)> CommandContinuation
a function to be called after ControlCommandHandler completes
Definition: dispatcher.hpp:95
void append(span< const uint8_t > bytes)
Appends a sequence of bytes to the response.
Provides ControlCommand authorization according to NFD configuration file.
Represents the Strategy Choice table.
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name const Interest const ControlParameters & parameters
represents an item in NFD StrategyChoice dataset
Provides a context for generating the response to a StatusDataset request.
const Name & getStrategy() const
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
StrategyChoice & setName(const Name &name)