status-dataset.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2022 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_STATUS_DATASET_HPP
#define NDN_CXX_MGMT_NFD_STATUS_DATASET_HPP
 
#include "ndn-cxx/name.hpp"
#include "ndn-cxx/mgmt/nfd/forwarder-status.hpp"
#include "ndn-cxx/mgmt/nfd/face-status.hpp"
#include "ndn-cxx/mgmt/nfd/face-query-filter.hpp"
#include "ndn-cxx/mgmt/nfd/channel-status.hpp"
#include "ndn-cxx/mgmt/nfd/fib-entry.hpp"
#include "ndn-cxx/mgmt/nfd/cs-info.hpp"
#include "ndn-cxx/mgmt/nfd/strategy-choice.hpp"
#include "ndn-cxx/mgmt/nfd/rib-entry.hpp"
 
namespace ndn {
namespace nfd {
 
class StatusDataset : noncopyable
{
public:
  virtual
  ~StatusDataset();
 
#ifdef DOXYGEN
  using ParamType = int;
#endif
 
  Name
  getDatasetPrefix(const Name& prefix) const;
 
#ifdef DOXYGEN
  using ResultType = std::vector<int>;
#endif
 
  class ParseResultError : public tlv::Error
  {
  public:
    using tlv::Error::Error;
  };
 
#ifdef DOXYGEN
  ResultType
  parseResult(ConstBufferPtr payload) const;
#endif
 
protected:
  explicit
  StatusDataset(const PartialName& datasetName);
 
private:
  virtual void
  addParameters(Name& name) const;
 
private:
  PartialName m_datasetName;
};
 
class ForwarderGeneralStatusDataset : public StatusDataset
{
public:
  ForwarderGeneralStatusDataset();
 
  using ResultType = ForwarderStatus;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
class FaceDatasetBase : public StatusDataset
{
public:
  using ResultType = std::vector<FaceStatus>;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
 
protected:
  explicit
  FaceDatasetBase(const PartialName& datasetName);
};
 
class FaceDataset : public FaceDatasetBase
{
public:
  FaceDataset();
};
 
class FaceQueryDataset : public FaceDatasetBase
{
public:
  using ParamType = FaceQueryFilter;
 
  explicit
  FaceQueryDataset(const FaceQueryFilter& filter);
 
private:
  void
  addParameters(Name& name) const override;
 
private:
  FaceQueryFilter m_filter;
};
 
class ChannelDataset : public StatusDataset
{
public:
  ChannelDataset();
 
  using ResultType = std::vector<ChannelStatus>;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
class FibDataset : public StatusDataset
{
public:
  FibDataset();
 
  using ResultType = std::vector<FibEntry>;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
class CsInfoDataset : public StatusDataset
{
public:
  CsInfoDataset();
 
  using ResultType = CsInfo;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
class StrategyChoiceDataset : public StatusDataset
{
public:
  StrategyChoiceDataset();
 
  using ResultType = std::vector<StrategyChoice>;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
class RibDataset : public StatusDataset
{
public:
  RibDataset();
 
  using ResultType = std::vector<RibEntry>;
 
  ResultType
  parseResult(ConstBufferPtr payload) const;
};
 
} // namespace nfd
} // namespace ndn
 
#endif // NDN_CXX_MGMT_NFD_STATUS_DATASET_HPP