NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
command-options.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2018 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 
23 
24 namespace ndn {
25 namespace nfd {
26 
27 const time::milliseconds CommandOptions::DEFAULT_TIMEOUT(10000);
28 const Name CommandOptions::DEFAULT_PREFIX("ndn:/localhost/nfd");
29 
31  : m_timeout(DEFAULT_TIMEOUT)
32  , m_prefix(DEFAULT_PREFIX)
33 {
34 }
35 
37 CommandOptions::setTimeout(const time::milliseconds& timeout)
38 {
39  if (timeout <= time::milliseconds::zero()) {
40  BOOST_THROW_EXCEPTION(std::out_of_range("Timeout must be positive"));
41  }
42 
43  m_timeout = timeout;
44  return *this;
45 }
46 
49 {
50  m_prefix = prefix;
51  return *this;
52 }
53 
56 {
57  m_signingInfo = signingInfo;
58  return *this;
59 }
60 
61 } // namespace nfd
62 } // namespace ndn
Copyright (c) 2011-2015 Regents of the University of California.
CommandOptions()
constructs CommandOptions
static const Name DEFAULT_PREFIX
gives the default command prefix: ndn:/localhost/nfd
Signing parameters passed to KeyChain.
CommandOptions & setTimeout(const time::milliseconds &timeout)
sets command timeout
contains options for ControlCommand execution
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
Represents an absolute name.
Definition: name.hpp:43
CommandOptions & setSigningInfo(const security::SigningInfo &signingInfo)
sets signing parameters
static const time::milliseconds DEFAULT_TIMEOUT
gives the default command timeout: 10000ms
CommandOptions & setPrefix(const Name &prefix)
sets command prefix