blob: 3d3808c0399d6becb345a9f91ac040a0e047605e [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2013-2016 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
* ndn-cxx library is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received copies of the GNU General Public License and GNU Lesser
* General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
* <http://www.gnu.org/licenses/>.
*
* See AUTHORS.md for complete list of ndn-cxx authors and contributors.
*/
#ifndef NDN_MGMT_NFD_CONTROLLER_HPP
#define NDN_MGMT_NFD_CONTROLLER_HPP
#include "control-command.hpp"
#include "control-response.hpp"
#include "status-dataset.hpp"
#include "command-options.hpp"
#include "../../security/validator-null.hpp"
namespace ndn {
namespace security {
class KeyChain;
class Validator;
} // namespace security
class Face;
namespace nfd {
/**
* \defgroup management Management
* \brief Classes and data structures to manage NDN forwarder
*/
/**
* \ingroup management
* \brief NFD Management protocol client
* \sa https://redmine.named-data.net/projects/nfd/wiki/Management
*/
class Controller : noncopyable
{
public:
/** \brief a callback on command success
*/
typedef function<void(const ControlParameters&)> CommandSucceedCallback;
/** \brief a callback on command failure
*/
typedef function<void(const ControlResponse&)> CommandFailCallback;
/** \brief a callback on dataset retrieval failure
*/
typedef function<void(uint32_t code, const std::string& reason)> DatasetFailCallback;
/** \brief construct a Controller that uses face for transport,
* and uses the passed KeyChain to sign commands
*/
Controller(Face& face, security::KeyChain& keyChain, security::Validator& validator = s_validatorNull);
/** \brief start command execution
*/
template<typename Command>
void
start(const ControlParameters& parameters,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure,
const CommandOptions& options = CommandOptions())
{
shared_ptr<ControlCommand> command = make_shared<Command>();
this->startCommand(command, parameters, onSuccess, onFailure, options);
}
/** \brief start dataset fetching
*/
template<typename Dataset>
typename std::enable_if<std::is_default_constructible<Dataset>::value>::type
fetch(const std::function<void(typename Dataset::ResultType)>& onSuccess,
const DatasetFailCallback& onFailure,
const CommandOptions& options = CommandOptions())
{
this->fetchDataset(make_shared<Dataset>(), onSuccess, onFailure, options);
}
/** \brief start dataset fetching
*/
template<typename Dataset, typename ParamType = typename Dataset::ParamType>
void
fetch(const ParamType& param,
const std::function<void(typename Dataset::ResultType)>& onSuccess,
const DatasetFailCallback& onFailure,
const CommandOptions& options = CommandOptions())
{
this->fetchDataset(make_shared<Dataset>(param), onSuccess, onFailure, options);
}
private:
void
startCommand(const shared_ptr<ControlCommand>& command,
const ControlParameters& parameters,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure,
const CommandOptions& options);
void
processCommandResponse(const Data& data,
const shared_ptr<ControlCommand>& command,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure);
void
processValidatedCommandResponse(const Data& data,
const shared_ptr<ControlCommand>& command,
const CommandSucceedCallback& onSuccess,
const CommandFailCallback& onFailure);
template<typename Dataset>
void
fetchDataset(shared_ptr<Dataset> dataset,
const std::function<void(typename Dataset::ResultType)>& onSuccess,
const DatasetFailCallback& onFailure,
const CommandOptions& options);
void
fetchDataset(const Name& prefix,
const std::function<void(const ConstBufferPtr&)>& processResponse,
const DatasetFailCallback& onFailure,
const CommandOptions& options);
template<typename Dataset>
void
processDatasetResponse(shared_ptr<Dataset> dataset,
const std::function<void(typename Dataset::ResultType)>& onSuccess,
const DatasetFailCallback& onFailure,
ConstBufferPtr payload);
void
processDatasetFetchError(const DatasetFailCallback& onFailure, uint32_t code, std::string msg);
public:
/** \brief error code for timeout
*/
static const uint32_t ERROR_TIMEOUT;
/** \brief error code for network Nack
*/
static const uint32_t ERROR_NACK;
/** \brief error code for response validation failure
*/
static const uint32_t ERROR_VALIDATION;
/** \brief error code for server error
*/
static const uint32_t ERROR_SERVER;
/** \brief inclusive lower bound of error codes
*/
static const uint32_t ERROR_LBOUND;
protected:
Face& m_face;
security::KeyChain& m_keyChain;
security::Validator& m_validator;
private:
static ValidatorNull s_validatorNull;
};
template<typename Dataset>
inline void
Controller::fetchDataset(shared_ptr<Dataset> dataset,
const std::function<void(typename Dataset::ResultType)>& onSuccess1,
const DatasetFailCallback& onFailure1,
const CommandOptions& options)
{
const std::function<void(typename Dataset::ResultType)>& onSuccess = onSuccess1 ?
onSuccess1 : [] (const typename Dataset::ResultType&) {};
const DatasetFailCallback& onFailure = onFailure1 ?
onFailure1 : [] (uint32_t, const std::string&) {};
Name prefix = dataset->getDatasetPrefix(options.getPrefix());
this->fetchDataset(prefix,
bind(&Controller::processDatasetResponse<Dataset>, this, dataset, onSuccess, onFailure, _1),
onFailure,
options);
}
template<typename Dataset>
inline void
Controller::processDatasetResponse(shared_ptr<Dataset> dataset,
const std::function<void(typename Dataset::ResultType)>& onSuccess,
const DatasetFailCallback& onFailure,
ConstBufferPtr payload)
{
typename Dataset::ResultType result;
try {
result = dataset->parseResult(payload);
}
catch (const tlv::Error& e) {
onFailure(ERROR_SERVER, e.what());
return;
}
onSuccess(result);
}
} // namespace nfd
} // namespace ndn
#endif // NDN_MGMT_NFD_CONTROLLER_HPP