command-options.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2017 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
23 #define NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
24 
25 #include "../../security/signing-info.hpp"
26 
27 namespace ndn {
28 namespace nfd {
29 
35 {
36 public:
43 
46  const time::milliseconds&
47  getTimeout() const
48  {
49  return m_timeout;
50  }
51 
58  setTimeout(const time::milliseconds& timeout);
59 
62  const Name&
63  getPrefix() const
64  {
65  return m_prefix;
66  }
67 
72  setPrefix(const Name& prefix);
73 
78  {
79  return m_signingInfo;
80  }
81 
86  setSigningInfo(const security::SigningInfo& signingInfo);
87 
88 public:
91  static const time::milliseconds DEFAULT_TIMEOUT;
92 
95  static const Name DEFAULT_PREFIX;
96 
97 private:
98  time::milliseconds m_timeout;
99  Name m_prefix;
100  security::SigningInfo m_signingInfo;
101 };
102 
103 } // namespace nfd
104 } // namespace ndn
105 
106 #endif // NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
Copyright (c) 2013-2017 Regents of the University of California.
Definition: common.hpp:66
CommandOptions()
constructs CommandOptions
static const Name DEFAULT_PREFIX
gives the default command prefix: ndn:/localhost/nfd
const Name & getPrefix() const
Signing parameters passed to KeyChain.
CommandOptions & setTimeout(const time::milliseconds &timeout)
sets command timeout
contains options for ControlCommand execution
Represents an absolute name.
Definition: name.hpp:42
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
sets signing parameters
static const time::milliseconds DEFAULT_TIMEOUT
gives the default command timeout: 10000ms
const time::milliseconds & getTimeout() const
CommandOptions & setPrefix(const Name &prefix)
sets command prefix
const security::SigningInfo & getSigningInfo() const