NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
manager-base.hpp
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 
26 #ifndef NFD_DAEMON_MGMT_MANAGER_BASE_HPP
27 #define NFD_DAEMON_MGMT_MANAGER_BASE_HPP
28 
30 
35 
36 namespace nfd {
37 
42 
47 class ManagerBase : noncopyable
48 {
49 public:
50  class Error : public std::runtime_error
51  {
52  public:
53  using std::runtime_error::runtime_error;
54  };
55 
56  virtual
57  ~ManagerBase();
58 
59  const std::string&
60  getModule() const
61  {
62  return m_module;
63  }
64 
65 protected:
69  ManagerBase(const std::string& module, Dispatcher& dispatcher);
70 
71  ManagerBase(const std::string& module, Dispatcher& dispatcher,
72  CommandAuthenticator& authenticator);
73 
74 NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED: // registrations to the dispatcher
75  // difference from mgmt::ControlCommand: accepts nfd::ControlParameters
76  using ControlCommandHandler = std::function<void(const ControlCommand& command,
77  const Name& prefix, const Interest& interest,
80 
81  template<typename Command>
82  void
83  registerCommandHandler(const std::string& verb,
84  const ControlCommandHandler& handler);
85 
86  void
87  registerStatusDatasetHandler(const std::string& verb,
88  const ndn::mgmt::StatusDatasetHandler& handler);
89 
91  registerNotificationStream(const std::string& verb);
92 
102  static void
103  extractRequester(const Interest& interest, const ndn::mgmt::AcceptContinuation& accept);
104 
110  makeAuthorization(const std::string& verb);
111 
118  static bool
119  validateParameters(const ControlCommand& command,
121 
125  static void
126  handleCommand(shared_ptr<ControlCommand> command,
127  const ControlCommandHandler& handler,
128  const Name& prefix, const Interest& interest,
129  const ndn::mgmt::ControlParameters& params,
131 
139  makeRelPrefix(const std::string& verb)
140  {
141  return PartialName(m_module).append(verb);
142  }
143 
144 private:
145  std::string m_module;
146  Dispatcher& m_dispatcher;
147  CommandAuthenticator* m_authenticator = nullptr;
148 };
149 
150 template<typename Command>
151 void
152 ManagerBase::registerCommandHandler(const std::string& verb,
153  const ControlCommandHandler& handler)
154 {
155  auto command = make_shared<Command>();
156 
157  m_dispatcher.addControlCommand<ControlParameters>(
158  makeRelPrefix(verb),
159  makeAuthorization(verb),
160  [=] (const auto& params) { return validateParameters(*command, params); },
161  [=] (auto&&... args) { handleCommand(command, handler, std::forward<decltype(args)>(args)...); });
162 }
163 
164 } // namespace nfd
165 
166 #endif // NFD_DAEMON_MGMT_MANAGER_BASE_HPP
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name & prefix
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name const Interest & interest
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
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
std::function< void(const Block &notification)> PostNotification
a function to post a notification
Definition: dispatcher.hpp:124
represents a dispatcher on server side of NFD Management protocol
Definition: dispatcher.hpp:130
base class of NFD ControlCommand
Represents an Interest packet.
Definition: interest.hpp:48
std::function< void(const std::string &requester)> AcceptContinuation
a function to be called if authorization is successful
Definition: dispatcher.hpp:45
Name & append(const Component &component)
Append a component.
Definition: name.hpp:275
ndn mgmt Dispatcher
Definition: dispatcher.cpp:26
ManagerBase(const std::string &module, Dispatcher &dispatcher)
static bool validateParameters(const ControlCommand &command, const ndn::mgmt::ControlParameters &parameters)
Validates the parameters for a given command.
const std::string & getModule() const
mgmt::ControlResponse ControlResponse
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:39
#define NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
Name PartialName
Represents an arbitrary sequence of name components.
Definition: name.hpp:36
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const ndn::mgmt::AcceptContinuation & accept
virtual ~ManagerBase()
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
PartialName makeRelPrefix(const std::string &verb)
Generates the relative prefix for a handler by appending the verb name to the module name...
base class for a struct that contains ControlCommand parameters
Provides ControlCommand authorization according to NFD configuration file.
std::function< void(const Name &prefix, const Interest &interest, const ControlParameters &params, const CommandContinuation &done)> ControlCommandHandler
a function to handle an authorized ControlCommand
Definition: dispatcher.hpp:106
#define NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED
Definition: common.hpp:40
void registerCommandHandler(const std::string &verb, const ControlCommandHandler &handler)
NFD_PUBLIC_WITH_TESTS_ELSE_PROTECTED const Name const Interest const ControlParameters & parameters
ndn::mgmt::PostNotification registerNotificationStream(const std::string &verb)
std::function< void(const Name &prefix, const Interest &interest, const ControlParameters *params, const AcceptContinuation &accept, const RejectContinuation &reject)> Authorization
a function that performs authorization
Definition: dispatcher.hpp:77
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
static void handleCommand(shared_ptr< ControlCommand > command, const ControlCommandHandler &handler, const Name &prefix, const Interest &interest, const ndn::mgmt::ControlParameters &params, const ndn::mgmt::CommandContinuation &done)
Handles a control command.
std::function< void(const Name &prefix, const Interest &interest, StatusDatasetContext &context)> StatusDatasetHandler
a function to handle a StatusDataset request
Definition: dispatcher.hpp:118