blob: e98b606462bf48242ca097958ce839af03f36388 [file] [log] [blame]
Junxiao Shi7357ef22016-09-07 02:39:37 +00001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -08002/*
Davide Pesaventodb4da5e2018-06-15 11:37:52 -04003 * Copyright (c) 2013-2018 Regents of the University of California.
Junxiao Shi7357ef22016-09-07 02:39:37 +00004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#ifndef NDN_MGMT_NFD_CONTROLLER_HPP
23#define NDN_MGMT_NFD_CONTROLLER_HPP
24
25#include "control-command.hpp"
26#include "control-response.hpp"
27#include "status-dataset.hpp"
28#include "command-options.hpp"
Alexander Afanasyev80782e02017-01-04 13:16:54 -080029#include "../../security/command-interest-signer.hpp"
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080030#include "../../security/validator-null.hpp"
31#include "../../security/v2/key-chain.hpp"
32#include "../../security/v2/validator.hpp"
Junxiao Shi7357ef22016-09-07 02:39:37 +000033
34namespace ndn {
35
Junxiao Shi7357ef22016-09-07 02:39:37 +000036class Face;
37
38namespace nfd {
39
40/**
41 * \defgroup management Management
42 * \brief Classes and data structures to manage NDN forwarder
43 */
44
45/**
46 * \ingroup management
47 * \brief NFD Management protocol client
48 * \sa https://redmine.named-data.net/projects/nfd/wiki/Management
49 */
50class Controller : noncopyable
51{
52public:
53 /** \brief a callback on command success
54 */
55 typedef function<void(const ControlParameters&)> CommandSucceedCallback;
56
57 /** \brief a callback on command failure
58 */
59 typedef function<void(const ControlResponse&)> CommandFailCallback;
60
61 /** \brief a callback on dataset retrieval failure
62 */
63 typedef function<void(uint32_t code, const std::string& reason)> DatasetFailCallback;
64
65 /** \brief construct a Controller that uses face for transport,
66 * and uses the passed KeyChain to sign commands
67 */
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -080068 Controller(Face& face, KeyChain& keyChain, security::v2::Validator& validator = security::getAcceptAllValidator());
Junxiao Shi7357ef22016-09-07 02:39:37 +000069
70 /** \brief start command execution
71 */
72 template<typename Command>
73 void
74 start(const ControlParameters& parameters,
75 const CommandSucceedCallback& onSuccess,
76 const CommandFailCallback& onFailure,
Eric Newberry71a2f032018-06-18 23:49:43 -070077 const CommandOptions& options = CommandOptions())
Junxiao Shi7357ef22016-09-07 02:39:37 +000078 {
79 shared_ptr<ControlCommand> command = make_shared<Command>();
80 this->startCommand(command, parameters, onSuccess, onFailure, options);
81 }
82
83 /** \brief start dataset fetching
84 */
85 template<typename Dataset>
Davide Pesaventodb4da5e2018-06-15 11:37:52 -040086 std::enable_if_t<std::is_default_constructible<Dataset>::value>
Junxiao Shi7357ef22016-09-07 02:39:37 +000087 fetch(const std::function<void(typename Dataset::ResultType)>& onSuccess,
88 const DatasetFailCallback& onFailure,
Eric Newberry71a2f032018-06-18 23:49:43 -070089 const CommandOptions& options = CommandOptions())
Junxiao Shi7357ef22016-09-07 02:39:37 +000090 {
91 this->fetchDataset(make_shared<Dataset>(), onSuccess, onFailure, options);
92 }
93
94 /** \brief start dataset fetching
95 */
96 template<typename Dataset, typename ParamType = typename Dataset::ParamType>
97 void
98 fetch(const ParamType& param,
99 const std::function<void(typename Dataset::ResultType)>& onSuccess,
100 const DatasetFailCallback& onFailure,
Eric Newberry71a2f032018-06-18 23:49:43 -0700101 const CommandOptions& options = CommandOptions())
Junxiao Shi7357ef22016-09-07 02:39:37 +0000102 {
103 this->fetchDataset(make_shared<Dataset>(param), onSuccess, onFailure, options);
104 }
105
106private:
107 void
108 startCommand(const shared_ptr<ControlCommand>& command,
109 const ControlParameters& parameters,
110 const CommandSucceedCallback& onSuccess,
111 const CommandFailCallback& onFailure,
112 const CommandOptions& options);
113
114 void
115 processCommandResponse(const Data& data,
116 const shared_ptr<ControlCommand>& command,
117 const CommandSucceedCallback& onSuccess,
118 const CommandFailCallback& onFailure);
119
120 void
121 processValidatedCommandResponse(const Data& data,
122 const shared_ptr<ControlCommand>& command,
123 const CommandSucceedCallback& onSuccess,
124 const CommandFailCallback& onFailure);
125
126 template<typename Dataset>
127 void
128 fetchDataset(shared_ptr<Dataset> dataset,
129 const std::function<void(typename Dataset::ResultType)>& onSuccess,
130 const DatasetFailCallback& onFailure,
131 const CommandOptions& options);
132
133 void
134 fetchDataset(const Name& prefix,
135 const std::function<void(const ConstBufferPtr&)>& processResponse,
136 const DatasetFailCallback& onFailure,
137 const CommandOptions& options);
138
139 template<typename Dataset>
140 void
141 processDatasetResponse(shared_ptr<Dataset> dataset,
142 const std::function<void(typename Dataset::ResultType)>& onSuccess,
143 const DatasetFailCallback& onFailure,
144 ConstBufferPtr payload);
145
146 void
147 processDatasetFetchError(const DatasetFailCallback& onFailure, uint32_t code, std::string msg);
148
149public:
150 /** \brief error code for timeout
151 */
152 static const uint32_t ERROR_TIMEOUT;
153
154 /** \brief error code for network Nack
155 */
156 static const uint32_t ERROR_NACK;
157
158 /** \brief error code for response validation failure
159 */
160 static const uint32_t ERROR_VALIDATION;
161
162 /** \brief error code for server error
163 */
164 static const uint32_t ERROR_SERVER;
165
166 /** \brief inclusive lower bound of error codes
167 */
168 static const uint32_t ERROR_LBOUND;
169
170protected:
171 Face& m_face;
Alexander Afanasyev80782e02017-01-04 13:16:54 -0800172 KeyChain& m_keyChain;
Alexander Afanasyev6dfeffe2017-01-30 22:40:32 -0800173 security::v2::Validator& m_validator;
Alexander Afanasyev80782e02017-01-04 13:16:54 -0800174 security::CommandInterestSigner m_signer;
Junxiao Shi7357ef22016-09-07 02:39:37 +0000175};
176
177template<typename Dataset>
178inline void
179Controller::fetchDataset(shared_ptr<Dataset> dataset,
180 const std::function<void(typename Dataset::ResultType)>& onSuccess1,
181 const DatasetFailCallback& onFailure1,
182 const CommandOptions& options)
183{
184 const std::function<void(typename Dataset::ResultType)>& onSuccess = onSuccess1 ?
185 onSuccess1 : [] (const typename Dataset::ResultType&) {};
186 const DatasetFailCallback& onFailure = onFailure1 ?
187 onFailure1 : [] (uint32_t, const std::string&) {};
188
189 Name prefix = dataset->getDatasetPrefix(options.getPrefix());
190 this->fetchDataset(prefix,
191 bind(&Controller::processDatasetResponse<Dataset>, this, dataset, onSuccess, onFailure, _1),
192 onFailure,
193 options);
194}
195
196template<typename Dataset>
197inline void
198Controller::processDatasetResponse(shared_ptr<Dataset> dataset,
199 const std::function<void(typename Dataset::ResultType)>& onSuccess,
200 const DatasetFailCallback& onFailure,
201 ConstBufferPtr payload)
202{
203 typename Dataset::ResultType result;
204 try {
205 result = dataset->parseResult(payload);
206 }
207 catch (const tlv::Error& e) {
208 onFailure(ERROR_SERVER, e.what());
209 return;
210 }
211
212 onSuccess(result);
213}
214
215} // namespace nfd
216} // namespace ndn
217
218#endif // NDN_MGMT_NFD_CONTROLLER_HPP