command-options.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
#ifndef NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
#define NDN_MGMT_NFD_COMMAND_OPTIONS_HPP

#include "../../security/signing-info.hpp"

#define NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS

namespace ndn {

namespace security {
namespace v1 {
class IdentityCertificate;
} // namespace v1
} // namespace security

namespace nfd {

class CommandOptions
{
public:
  CommandOptions();

  const time::milliseconds&
  getTimeout() const
  {
    return m_timeout;
  }

  CommandOptions&
  setTimeout(const time::milliseconds& timeout);

  const Name&
  getPrefix() const
  {
    return m_prefix;
  }

  CommandOptions&
  setPrefix(const Name& prefix);

  const security::SigningInfo&
  getSigningInfo() const
  {
    return m_signingInfo;
  }

  CommandOptions&
  setSigningInfo(const security::SigningInfo& signingInfo);

#ifdef NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
public: // signing parameters
  enum SigningParamsKind {
    SIGNING_PARAMS_DEFAULT,
    SIGNING_PARAMS_IDENTITY,
    SIGNING_PARAMS_CERTIFICATE
  };

  DEPRECATED(
  SigningParamsKind
  getSigningParamsKind() const);

  DEPRECATED(
  const Name&
  getSigningIdentity() const);

  DEPRECATED(
  const Name&
  getSigningCertificate() const);

  DEPRECATED(
  CommandOptions&
  setSigningDefault());

  DEPRECATED(
  CommandOptions&
  setSigningIdentity(const Name& identityName));

  DEPRECATED(
  CommandOptions&
  setSigningCertificate(const Name& certificateName));

  DEPRECATED(
  CommandOptions&
  setSigningCertificate(const security::v1::IdentityCertificate& certificate));

#endif // NDN_MGMT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS

public:
  static const time::milliseconds DEFAULT_TIMEOUT;

  static const Name DEFAULT_PREFIX;

private:
  time::milliseconds m_timeout;
  Name m_prefix;
  security::SigningInfo m_signingInfo;
};

} // namespace nfd
} // namespace ndn

#endif // NDN_MGMT_NFD_COMMAND_OPTIONS_HPP