controller.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2025 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_CXX_MGMT_NFD_CONTROLLER_HPP
#define NDN_CXX_MGMT_NFD_CONTROLLER_HPP
 
#include "ndn-cxx/mgmt/nfd/command-options.hpp"
#include "ndn-cxx/mgmt/nfd/control-parameters.hpp"
#include "ndn-cxx/mgmt/nfd/control-response.hpp"
#include "ndn-cxx/security/interest-signer.hpp"
#include "ndn-cxx/security/key-chain.hpp"
#include "ndn-cxx/security/validator-null.hpp"
#include "ndn-cxx/util/segment-fetcher.hpp"
 
namespace ndn {
 
class Face;
 
namespace nfd {
 
using CommandSuccessCallback = std::function<void(const ControlParameters&)>;
 
using CommandFailureCallback = std::function<void(const ControlResponse&)>;
 
template<typename Dataset>
using DatasetSuccessCallback =
  std::function<void(const std::invoke_result_t<decltype(&Dataset::parseResult), Dataset, ConstBufferPtr>&)>;
 
using DatasetFailureCallback = std::function<void(uint32_t code, const std::string& reason)>;
 
class Controller : noncopyable
{
public:
  Controller(Face& face, KeyChain& keyChain,
             security::Validator& validator = security::getAcceptAllValidator());
 
  ~Controller();
 
  template<typename Command,
           typename CommandParameters = typename Command::RequestParameters>
  void
  start(const CommandParameters& parameters,
        CommandSuccessCallback onSuccess,
        const CommandFailureCallback& onFailure,
        const CommandOptions& options = {})
  {
    auto request = Command::createRequest(options.getPrefix(), parameters);
    request.setInterestLifetime(options.getTimeout());
    sendCommandRequest(request, options.getSigningInfo(),
                       [] (const auto& responseParams) { Command::validateResponse(responseParams); },
                       std::move(onSuccess), onFailure);
  }
 
  template<typename Dataset>
  std::enable_if_t<std::is_default_constructible_v<Dataset>>
  fetch(const DatasetSuccessCallback<Dataset>& onSuccess,
        const DatasetFailureCallback& onFailure,
        const CommandOptions& options = {})
  {
    fetchDataset(Dataset(), onSuccess, onFailure, options);
  }
 
  template<typename Dataset, typename ParamType>
  void
  fetch(ParamType&& param,
        const DatasetSuccessCallback<Dataset>& onSuccess,
        const DatasetFailureCallback& onFailure,
        const CommandOptions& options = {})
  {
    fetchDataset(Dataset(std::forward<ParamType>(param)), onSuccess, onFailure, options);
  }
 
private:
  using ResponseParametersValidator = std::function<void(const ControlParameters&)>;
 
  void
  sendCommandRequest(Interest& interest,
                     const security::SigningInfo& signingInfo,
                     ResponseParametersValidator checkResponse,
                     CommandSuccessCallback onSuccess,
                     const CommandFailureCallback& onFailure);
 
  void
  processCommandResponse(const Data& data,
                         ResponseParametersValidator checkResponse,
                         CommandSuccessCallback onSuccess,
                         const CommandFailureCallback& onFailure);
 
  static void
  processValidatedCommandResponse(const Data& data,
                                  const ResponseParametersValidator& checkResponse,
                                  const CommandSuccessCallback& onSuccess,
                                  const CommandFailureCallback& onFailure);
 
  template<typename Dataset>
  void
  fetchDataset(Dataset&& dataset,
               const DatasetSuccessCallback<Dataset>& onSuccess,
               const DatasetFailureCallback& onFailure,
               const CommandOptions& options);
 
  void
  fetchDataset(const Name& prefix,
               const std::function<void(ConstBufferPtr)>& processResponse,
               const DatasetFailureCallback& onFailure,
               const CommandOptions& options);
 
  static void
  processDatasetFetchError(const DatasetFailureCallback& onFailure, uint32_t code, std::string msg);
 
public:
  enum : uint32_t {
    ERROR_LBOUND = 400,
    ERROR_SERVER = 500,
    ERROR_TIMEOUT = 10060,
    ERROR_NACK = 10800,
    ERROR_VALIDATION = 10021,
  };
 
protected:
  Face& m_face;
  KeyChain& m_keyChain;
  security::Validator& m_validator;
  security::InterestSigner m_signer;
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED:
  std::set<shared_ptr<SegmentFetcher>> m_fetchers;
};
 
template<typename Dataset>
void
Controller::fetchDataset(Dataset&& dataset,
                         const DatasetSuccessCallback<Dataset>& onSuccess,
                         const DatasetFailureCallback& onFailure,
                         const CommandOptions& options)
{
  Name prefix = dataset.getDatasetPrefix(options.getPrefix());
  fetchDataset(prefix,
    [=, dataset = std::forward<Dataset>(dataset)] (ConstBufferPtr payload) {
      std::invoke_result_t<decltype(&Dataset::parseResult), Dataset, ConstBufferPtr> result;
      try {
        result = dataset.parseResult(std::move(payload));
      }
      catch (const tlv::Error& e) {
        if (onFailure)
          onFailure(ERROR_SERVER, "Dataset decoding failure: "s + e.what());
        return;
      }
      if (onSuccess)
        onSuccess(result);
    },
    onFailure, options);
}
 
} // namespace nfd
} // namespace ndn
 
#endif // NDN_CXX_MGMT_NFD_CONTROLLER_HPP