blob: 72cfa1c44f4ae02758a87f67342e8dfc034bb9c9 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013-2017 Regents of the University of California.
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
* ndn-cxx library is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later version.
*
* ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
*
* You should have received copies of the GNU General Public License and GNU Lesser
* General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
* <http://www.gnu.org/licenses/>.
*
* See AUTHORS.md for complete list of ndn-cxx authors and contributors.
*/
#ifndef NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
#define NDN_MGMT_NFD_COMMAND_OPTIONS_HPP
#include "../../security/signing-info.hpp"
namespace ndn {
namespace nfd {
/** \ingroup management
* \brief contains options for ControlCommand execution
* \note This type is intentionally copyable
*/
class CommandOptions
{
public:
/** \brief constructs CommandOptions
* \post getTimeout() == DEFAULT_TIMEOUT
* \post getPrefix() == DEFAULT_PREFIX
* \post getSigningInfo().getSignerType() == SIGNER_TYPE_NULL
*/
CommandOptions();
/** \return command timeout
*/
const time::milliseconds&
getTimeout() const
{
return m_timeout;
}
/** \brief sets command timeout
* \param timeout the new command timeout, must be positive
* \throw std::out_of_range if timeout is non-positive
* \return self
*/
CommandOptions&
setTimeout(const time::milliseconds& timeout);
/** \return command prefix
*/
const Name&
getPrefix() const
{
return m_prefix;
}
/** \brief sets command prefix
* \return self
*/
CommandOptions&
setPrefix(const Name& prefix);
/** \return signing parameters
*/
const security::SigningInfo&
getSigningInfo() const
{
return m_signingInfo;
}
/** \brief sets signing parameters
* \return self
*/
CommandOptions&
setSigningInfo(const security::SigningInfo& signingInfo);
public:
/** \brief gives the default command timeout: 10000ms
*/
static const time::milliseconds DEFAULT_TIMEOUT;
/** \brief gives the default command prefix: ndn:/localhost/nfd
*/
static const Name DEFAULT_PREFIX;
private:
time::milliseconds m_timeout;
Name m_prefix;
security::SigningInfo m_signingInfo;
};
} // namespace nfd
} // namespace ndn
#endif // NDN_MGMT_NFD_COMMAND_OPTIONS_HPP