blob: bcd43d710ba0faf2ba078fc1544a8a6a0e6d00dc [file] [log] [blame]
Alexander Afanasyev3ecec502014-04-16 13:42:44 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2014 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_RIB_RIB_MANAGER_HPP
27#define NFD_RIB_RIB_MANAGER_HPP
28
29#include "rib.hpp"
30#include "face-monitor.hpp"
31#include "core/config-file.hpp"
32
Alexander Afanasyev4a771362014-04-24 21:29:33 -070033#include <ndn-cxx/security/validator-config.hpp>
34#include <ndn-cxx/management/nfd-controller.hpp>
35#include <ndn-cxx/management/nfd-control-command.hpp>
36#include <ndn-cxx/management/nfd-control-response.hpp>
37#include <ndn-cxx/management/nfd-control-parameters.hpp>
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070038
39namespace nfd {
40namespace rib {
41
42using ndn::nfd::ControlCommand;
43using ndn::nfd::ControlResponse;
44using ndn::nfd::ControlParameters;
45
46class RibManager : noncopyable
47{
48public:
Yingdi Yue5224e92014-04-29 18:04:02 -070049 class Error : public std::runtime_error
50 {
51 public:
52 explicit
53 Error(const std::string& what)
54 : std::runtime_error(what)
55 {
56 }
57 };
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070058
Yingdi Yue5224e92014-04-29 18:04:02 -070059 RibManager();
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070060
61 void
62 registerWithNfd();
63
64 void
65 enableLocalControlHeader();
66
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070067 void
68 setConfigFile(ConfigFile& configFile);
69
70private:
71 void
72 onConfig(const ConfigSection& configSection,
73 bool isDryRun,
74 const std::string& filename);
75
76 void
Junxiao Shia3295742014-05-16 22:40:10 -070077 startListening(const Name& commandPrefix, const ndn::OnInterest& onRequest);
78
79 void
Yingdi Yue5224e92014-04-29 18:04:02 -070080 onLocalhopRequest(const Interest& request);
81
82 void
83 onLocalhostRequest(const Interest& request);
84
85 void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070086 sendResponse(const Name& name,
87 const ControlResponse& response);
88
89 void
90 sendResponse(const Name& name,
91 uint32_t code,
92 const std::string& text);
93
94 void
Alexander Afanasyev20d31442014-04-19 17:00:53 -070095 registerEntry(const shared_ptr<const Interest>& request,
96 ControlParameters& parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070097
98 void
Alexander Afanasyev20d31442014-04-19 17:00:53 -070099 unregisterEntry(const shared_ptr<const Interest>& request,
100 ControlParameters& parameters);
101
102 void
103 onCommandValidated(const shared_ptr<const Interest>& request);
104
105 void
106 onCommandValidationFailed(const shared_ptr<const Interest>& request,
107 const std::string& failureInfo);
108
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700109
110 void
111 onCommandError(uint32_t code, const std::string& error,
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700112 const shared_ptr<const Interest>& request,
113 const RibEntry& ribEntry);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700114
115 void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700116 onRegSuccess(const shared_ptr<const Interest>& request,
117 const ControlParameters& parameters,
118 const RibEntry& ribEntry);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700119
120 void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700121 onUnRegSuccess(const shared_ptr<const Interest>& request,
122 const ControlParameters& parameters,
123 const RibEntry& ribEntry);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700124
125 void
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700126 onNrdCommandPrefixAddNextHopSuccess(const Name& prefix);
127
128 void
129 onNrdCommandPrefixAddNextHopError(const Name& name, const std::string& msg);
130
131 void
132 onAddNextHopSuccess(const Name& prefix);
133
134 void
135 onAddNextHopError(const Name& name, const std::string& msg);
136
137 void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700138 onControlHeaderSuccess();
139
140 void
141 onControlHeaderError(uint32_t code, const std::string& reason);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700142 static bool
143 extractParameters(const Name::Component& parameterComponent,
144 ControlParameters& extractedParameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700145
146 bool
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700147 validateParameters(const ControlCommand& command,
148 ControlParameters& parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700149
150 void
151 onNotification(const FaceEventNotification& notification);
152
153private:
154 Rib m_managedRib;
Yingdi Yuf4db0b52014-04-17 13:17:39 -0700155 ndn::Face m_face;
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700156 ndn::nfd::Controller m_nfdController;
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700157 ndn::KeyChain m_keyChain;
Yingdi Yue5224e92014-04-29 18:04:02 -0700158 ndn::ValidatorConfig m_localhostValidator;
159 ndn::ValidatorConfig m_localhopValidator;
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700160 FaceMonitor m_faceMonitor;
Yingdi Yue5224e92014-04-29 18:04:02 -0700161 bool m_isLocalhopEnabled;
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700162
Alexander Afanasyevf6980282014-05-13 18:28:40 -0700163 typedef function<void(RibManager*,
164 const shared_ptr<const Interest>& request,
165 ControlParameters& parameters)> VerbProcessor;
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700166
167 typedef std::map<name::Component, VerbProcessor> VerbDispatchTable;
168
169 typedef std::pair<name::Component, VerbProcessor> VerbAndProcessor;
170
171
172 const VerbDispatchTable m_verbDispatch;
173
174 static const Name COMMAND_PREFIX; // /localhost/nrd
175 static const Name REMOTE_COMMAND_PREFIX; // /localhop/nrd
176
177 // number of components in an invalid, but not malformed, unsigned command.
178 // (/localhost/nrd + verb + options) = 4
179 static const size_t COMMAND_UNSIGNED_NCOMPS;
180
181 // number of components in a valid signed Interest.
182 // 8 with signed Interest support.
183 static const size_t COMMAND_SIGNED_NCOMPS;
184
185 static const VerbAndProcessor COMMAND_VERBS[];
186};
187
188} // namespace rib
189} // namespace nfd
190
191#endif // NFD_RIB_RIB_MANAGER_HPP