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-2023 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::nfd {
28 
35 {
36 public:
43  CommandOptions() = default;
44 
49  getTimeout() const
50  {
51  return m_timeout;
52  }
53 
62 
66  const Name&
67  getPrefix() const
68  {
69  return m_prefix;
70  }
71 
77  setPrefix(Name prefix);
78 
84  {
85  return m_signingInfo;
86  }
87 
94 
95 public:
97  static constexpr time::milliseconds DEFAULT_TIMEOUT = 10_s;
98 
100  static inline const Name DEFAULT_PREFIX{"/localhost/nfd"};
101 
102 private:
104  Name m_prefix = DEFAULT_PREFIX;
105  security::SigningInfo m_signingInfo;
106 };
107 
108 } // namespace ndn::nfd
109 
110 #endif // NDN_CXX_MGMT_NFD_COMMAND_OPTIONS_HPP
Represents an absolute name.
Definition: name.hpp:45
Contains options for ControlCommand execution.
CommandOptions & setTimeout(time::milliseconds timeout)
Sets the command timeout.
CommandOptions & setPrefix(Name prefix)
Sets the command prefix.
const Name & getPrefix() const
Returns the command prefix.
time::milliseconds getTimeout() const
Returns the command timeout.
CommandOptions & setSigningInfo(security::SigningInfo signingInfo)
Sets the signing parameters.
const security::SigningInfo & getSigningInfo() const
Returns the signing parameters.
static const Name DEFAULT_PREFIX
The default command prefix: /localhost/nfd.
static constexpr time::milliseconds DEFAULT_TIMEOUT
The default command timeout: 10 seconds.
CommandOptions()=default
Constructs CommandOptions.
Signing parameters passed to KeyChain.
Contains classes and functions related to the NFD Management protocol.
::boost::chrono::milliseconds milliseconds
Definition: time.hpp:52