control-command.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013-2021 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_CONTROL_COMMAND_HPP
#define NDN_CXX_MGMT_NFD_CONTROL_COMMAND_HPP

#include "ndn-cxx/mgmt/nfd/control-parameters.hpp"

namespace ndn {
namespace nfd {

class ControlCommand : noncopyable
{
public:
  class ArgumentError : public std::invalid_argument
  {
  public:
    explicit
    ArgumentError(const std::string& what)
      : std::invalid_argument(what)
    {
    }
  };

  virtual
  ~ControlCommand();

  virtual void
  validateRequest(const ControlParameters& parameters) const;

  virtual void
  applyDefaultsToRequest(ControlParameters& parameters) const;

  virtual void
  validateResponse(const ControlParameters& parameters) const;

  virtual void
  applyDefaultsToResponse(ControlParameters& parameters) const;

  Name
  getRequestName(const Name& commandPrefix, const ControlParameters& parameters) const;

protected:
  ControlCommand(const std::string& module, const std::string& verb);

  class FieldValidator
  {
  public:
    FieldValidator();

    FieldValidator&
    required(ControlParameterField field)
    {
      m_required[field] = true;
      return *this;
    }

    FieldValidator&
    optional(ControlParameterField field)
    {
      m_optional[field] = true;
      return *this;
    }

    void
    validate(const ControlParameters& parameters) const;

  private:
    std::vector<bool> m_required;
    std::vector<bool> m_optional;
  };

protected:
  FieldValidator m_requestValidator;
  FieldValidator m_responseValidator;

private:
  name::Component m_module;
  name::Component m_verb;
};


class FaceCreateCommand : public ControlCommand
{
public:
  FaceCreateCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class FaceUpdateCommand : public ControlCommand
{
public:
  FaceUpdateCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class FaceDestroyCommand : public ControlCommand
{
public:
  FaceDestroyCommand();

  void
  validateRequest(const ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class FibAddNextHopCommand : public ControlCommand
{
public:
  FibAddNextHopCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class FibRemoveNextHopCommand : public ControlCommand
{
public:
  FibRemoveNextHopCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class CsConfigCommand : public ControlCommand
{
public:
  CsConfigCommand();
};


class CsEraseCommand : public ControlCommand
{
public:
  CsEraseCommand();

  void
  validateRequest(const ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class StrategyChoiceSetCommand : public ControlCommand
{
public:
  StrategyChoiceSetCommand();
};


class StrategyChoiceUnsetCommand : public ControlCommand
{
public:
  StrategyChoiceUnsetCommand();

  void
  validateRequest(const ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class RibRegisterCommand : public ControlCommand
{
public:
  RibRegisterCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};


class RibUnregisterCommand : public ControlCommand
{
public:
  RibUnregisterCommand();

  void
  applyDefaultsToRequest(ControlParameters& parameters) const override;

  void
  validateResponse(const ControlParameters& parameters) const override;
};

} // namespace nfd
} // namespace ndn

#endif // NDN_CXX_MGMT_NFD_CONTROL_COMMAND_HPP