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-2022 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_CXX_MGMT_NFD_COMMAND_OPTIONS_HPP
23 #define NDN_CXX_MGMT_NFD_COMMAND_OPTIONS_HPP
24 
26 
27 namespace ndn {
28 namespace nfd {
29 
35 {
36 public:
43 
48  getTimeout() const
49  {
50  return m_timeout;
51  }
52 
59  setTimeout(const time::milliseconds& timeout);
60 
64  const Name&
65  getPrefix() const
66  {
67  return m_prefix;
68  }
69 
74  setPrefix(const Name& prefix);
75 
81  {
82  return m_signingInfo;
83  }
84 
89  setSigningInfo(const security::SigningInfo& signingInfo);
90 
91 public:
94 
96  static const Name DEFAULT_PREFIX;
97 
98 private:
99  time::milliseconds m_timeout;
100  Name m_prefix;
101  security::SigningInfo m_signingInfo;
102 };
103 
104 } // namespace nfd
105 } // namespace ndn
106 
107 #endif // NDN_CXX_MGMT_NFD_COMMAND_OPTIONS_HPP
Represents an absolute name.
Definition: name.hpp:44
Contains options for ControlCommand execution.
static const time::milliseconds DEFAULT_TIMEOUT
The default command timeout: 10 seconds.
CommandOptions & setPrefix(const Name &prefix)
Sets the command prefix.
CommandOptions & setTimeout(const time::milliseconds &timeout)
Sets the command timeout.
const Name & getPrefix() const
Returns the command prefix.
time::milliseconds getTimeout() const
Returns the command timeout.
const security::SigningInfo & getSigningInfo() const
Returns the signing parameters.
static const Name DEFAULT_PREFIX
The default command prefix: /localhost/nfd.
CommandOptions()
Constructs CommandOptions.
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
Sets the signing parameters.
Signing parameters passed to KeyChain.
boost::chrono::milliseconds milliseconds
Definition: time.hpp:48
Definition: data.cpp:25