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-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 
28 #include <ndn-cxx/mgmt/nfd/strategy-choice.hpp>
29 #include <boost/lexical_cast.hpp>
30 
31 namespace nfd {
32 
33 NFD_LOG_INIT("StrategyChoiceManager");
34 
36  Dispatcher& dispatcher,
37  CommandAuthenticator& authenticator)
38  : NfdManagerBase(dispatcher, authenticator, "strategy-choice")
39  , m_table(strategyChoice)
40 {
41  registerCommandHandler<ndn::nfd::StrategyChoiceSetCommand>("set",
42  bind(&StrategyChoiceManager::setStrategy, this, _4, _5));
43  registerCommandHandler<ndn::nfd::StrategyChoiceUnsetCommand>("unset",
44  bind(&StrategyChoiceManager::unsetStrategy, this, _4, _5));
45 
47  bind(&StrategyChoiceManager::listChoices, this, _3));
48 }
49 
50 void
51 StrategyChoiceManager::setStrategy(ControlParameters parameters,
53 {
54  const Name& prefix = parameters.getName();
55  const Name& strategy = parameters.getStrategy();
56 
57  StrategyChoice::InsertResult res = m_table.insert(prefix, strategy);
58  if (!res) {
59  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): cannot-create " << res);
60  return done(ControlResponse(res.getStatusCode(), boost::lexical_cast<std::string>(res)));
61  }
62 
63  NFD_LOG_DEBUG("strategy-choice/set(" << prefix << "," << strategy << "): OK");
64  bool hasEntry = false;
65  Name instanceName;
66  std::tie(hasEntry, instanceName) = m_table.get(prefix);
67  BOOST_ASSERT_MSG(hasEntry, "StrategyChoice entry must exist after StrategyChoice::insert");
68  parameters.setStrategy(instanceName);
69  return done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
70 }
71 
72 void
73 StrategyChoiceManager::unsetStrategy(ControlParameters parameters,
75 {
76  const Name& prefix = parameters.getName();
77  // no need to test for ndn:/ , parameter validation takes care of that
78 
79  m_table.erase(parameters.getName());
80 
81  NFD_LOG_DEBUG("strategy-choice/unset(" << prefix << "): OK");
82  done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
83 }
84 
85 void
86 StrategyChoiceManager::listChoices(ndn::mgmt::StatusDatasetContext& context)
87 {
88  for (const auto& i : m_table) {
90  entry.setName(i.getPrefix())
91  .setStrategy(i.getStrategyInstanceName());
92  context.append(entry.wireEncode());
93  }
94  context.end();
95 }
96 
97 } // namespace nfd
int getStatusCode() const
get a status code for use in management command response
StrategyChoiceManager(strategy_choice::StrategyChoice &table, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
represents parameters in a ControlCommand request or response
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:130
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
#define NFD_LOG_DEBUG(expression)
Definition: logger.hpp:55
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:40
void end()
end the response successfully after appending zero or more blocks
size_t wireEncode(EncodingImpl< TAG > &encoder) const
Represents an absolute name.
Definition: name.hpp:42
std::function< void(const ControlResponse &resp)> CommandContinuation
a function to be called after ControlCommandHandler completes
Definition: dispatcher.hpp:95
provides ControlCommand authorization according to NFD configuration file
represents the Strategy Choice table
void append(const Block &block)
append a Block to the response
represents an item in NFD StrategyChoice dataset
provides a context for generating response to a StatusDataset request
a collection of common functions shared by all NFD managers, such as communicating with the dispatche...
#define NFD_LOG_INIT(name)
Definition: logger.hpp:34
const Name & getStrategy() const
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
StrategyChoice & setName(const Name &name)