NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.0: NDN, CCN, CCNx, content centric networks 		API Documentation
nfd-command-options.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
22 #ifndef NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_HPP
23 #define NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_HPP
24 
25 #include "../security/signing-info.hpp"
26 
27 #define NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
28 
29 namespace ndn {
30 
31 class IdentityCertificate;
32 
33 namespace nfd {
34 
39 class CommandOptions
40 {
41 public:
47  CommandOptions();
48 
51  const time::milliseconds&
52  getTimeout() const
53  {
54  return m_timeout;
55  }
56 
62  CommandOptions&
63  setTimeout(const time::milliseconds& timeout);
64 
67  const Name&
68  getPrefix() const
69  {
70  return m_prefix;
71  }
72 
76  CommandOptions&
77  setPrefix(const Name& prefix);
78 
81  const security::SigningInfo&
82  getSigningInfo() const
83  {
84  return m_signingInfo;
85  }
86 
90  CommandOptions&
91  setSigningInfo(const security::SigningInfo& signingInfo);
92 
93 #ifdef NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
94 public: // signing parameters
98  enum SigningParamsKind {
101  SIGNING_PARAMS_DEFAULT,
104  SIGNING_PARAMS_IDENTITY,
107  SIGNING_PARAMS_CERTIFICATE
108  };
109 
113  DEPRECATED(
114  SigningParamsKind
115  getSigningParamsKind() const);
116 
121  DEPRECATED(
122  const Name&
123  getSigningIdentity() const);
124 
129  DEPRECATED(
130  const Name&
131  getSigningCertificate() const);
132 
138  DEPRECATED(
139  CommandOptions&
140  setSigningDefault());
141 
148  DEPRECATED(
149  CommandOptions&
150  setSigningIdentity(const Name& identityName));
151 
160  DEPRECATED(
161  CommandOptions&
162  setSigningCertificate(const Name& certificateName));
163 
168  DEPRECATED(
169  CommandOptions&
170  setSigningCertificate(const IdentityCertificate& certificate));
171 
172 #endif // NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_KEEP_DEPRECATED_SIGNING_PARAMS
173 
174 public:
177  static const time::milliseconds DEFAULT_TIMEOUT;
178 
181  static const Name DEFAULT_PREFIX;
182 
183 private:
184  time::milliseconds m_timeout;
185  Name m_prefix;
186  security::SigningInfo m_signingInfo;
187 };
188 
189 } // namespace nfd
190 } // namespace ndn
191 
192 #endif // NDN_MANAGEMENT_NFD_COMMAND_OPTIONS_HPP
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-strategy-choice-helper.hpp:34
ndn::nfd::CommandOptions::CommandOptions
CommandOptions()
constructs CommandOptions
Definition: nfd-command-options.cpp:35
ndn::nfd::CommandOptions::SIGNING_PARAMS_IDENTITY
picks the default certificate of a specific identity Name
Definition: nfd-command-options.hpp:104
ndn::nfd::CommandOptions::DEFAULT_PREFIX
static const Name DEFAULT_PREFIX
gives the default command prefix: ndn:/localhost/nfd
Definition: nfd-command-options.hpp:181
ndn::nfd::CommandOptions::getPrefix
const Name & getPrefix() const
Definition: nfd-command-options.hpp:68
ndn::security::SigningInfo
Signing parameters passed to KeyChain.
Definition: signing-info.hpp:36
ndn::nfd::CommandOptions::setTimeout
CommandOptions & setTimeout(const time::milliseconds &timeout)
sets command timeout
Definition: nfd-command-options.cpp:42
ndn::nfd::CommandOptions
contains options for ControlCommand execution
Definition: nfd-command-options.hpp:39
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:38
ndn::Name
Name abstraction to represent an absolute name.
Definition: name.hpp:46
ndn::nfd::CommandOptions::DEPRECATED
DEPRECATED(SigningParamsKind getSigningParamsKind() const)
ndn::nfd::CommandOptions::setSigningInfo
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
sets signing parameters
Definition: nfd-command-options.cpp:60
ndn::nfd::CommandOptions::SIGNING_PARAMS_DEFAULT
picks the default signing identity and certificate
Definition: nfd-command-options.hpp:101
ndn::nfd::CommandOptions::DEFAULT_TIMEOUT
static const time::milliseconds DEFAULT_TIMEOUT
gives the default command timeout: 10000ms
Definition: nfd-command-options.hpp:177
ndn::nfd::CommandOptions::SigningParamsKind
SigningParamsKind
indicates the selection of signing parameters
Definition: nfd-command-options.hpp:98
ndn::nfd::CommandOptions::getTimeout
const time::milliseconds & getTimeout() const
Definition: nfd-command-options.hpp:52
ndn::nfd::CommandOptions::setPrefix
CommandOptions & setPrefix(const Name &prefix)
sets command prefix
Definition: nfd-command-options.cpp:53
ndn::nfd::CommandOptions::getSigningInfo
const security::SigningInfo & getSigningInfo() const
Definition: nfd-command-options.hpp:82