Public Types | Public Member Functions | Static Public Attributes
ndn::nfd::CommandOptions Class Reference
Management

contains options for ControlCommand execution More...

#include <command-options.hpp>

Collaboration diagram for ndn::nfd::CommandOptions:
[legend]

Public Types

enum  SigningParamsKind { SIGNING_PARAMS_DEFAULT, SIGNING_PARAMS_IDENTITY, SIGNING_PARAMS_CERTIFICATE }
 indicates the selection of signing parameters More...
 

Public Member Functions

 CommandOptions ()
 constructs CommandOptions More...
 
const time::milliseconds & getTimeout () const
 
CommandOptions & setTimeout (const time::milliseconds &timeout)
 sets command timeout More...
 
const Name & getPrefix () const
 
CommandOptions & setPrefix (const Name &prefix)
 sets command prefix More...
 
const security::SigningInfo & getSigningInfo () const
 
CommandOptions & setSigningInfo (const security::SigningInfo &signingInfo)
 sets signing parameters More...
 
SigningParamsKind getSigningParamsKind () const
 
const Name & getSigningIdentity () const
 
const Name & getSigningCertificate () const
 
CommandOptions & setSigningDefault ()
 chooses to use default identity and certificate More...
 
CommandOptions & setSigningIdentity (const Name &identityName)
 chooses to use a specific identity and its default certificate More...
 
CommandOptions & setSigningCertificate (const Name &certificateName)
 chooses to use a specific identity certificate More...
 
CommandOptions & setSigningCertificate (const security::v1::IdentityCertificate &certificate)
 chooses to use a specific identity certificate More...
 

Static Public Attributes

static const time::milliseconds DEFAULT_TIMEOUT
 gives the default command timeout: 10000ms More...
 
static const Name DEFAULT_PREFIX
 gives the default command prefix: ndn:/localhost/nfd More...
 

Detailed Description

contains options for ControlCommand execution

Note
This type is intentionally copyable

Definition at line 43 of file command-options.hpp.

Constructor & Destructor Documentation

ndn::nfd::CommandOptions::CommandOptions ( )

constructs CommandOptions

Postcondition
getTimeout() == DEFAULT_TIMEOUT
getPrefix() == DEFAULT_PREFIX
getSigningInfo().getSignerType() == SIGNER_TYPE_NULL

Definition at line 35 of file command-options.cpp.

Member Function Documentation

const Name& ndn::nfd::CommandOptions::getPrefix ( ) const
inline
Returns
command prefix

Definition at line 72 of file command-options.hpp.

const Name& ndn::nfd::CommandOptions::getSigningCertificate ( ) const
Deprecated:
use getSigningInfo and setSigningInfo
Returns
certificate Name
Precondition
getSigningParamsKind() == SIGNING_PARAMS_CERTIFICATE
const Name& ndn::nfd::CommandOptions::getSigningIdentity ( ) const
Deprecated:
use getSigningInfo and setSigningInfo
Returns
identity Name
Precondition
getSigningParamsKind() == SIGNING_PARAMS_IDENTITY
const security::SigningInfo& ndn::nfd::CommandOptions::getSigningInfo ( ) const
inline
Returns
signing parameters

Definition at line 86 of file command-options.hpp.

SigningParamsKind ndn::nfd::CommandOptions::getSigningParamsKind ( ) const
Deprecated:
use getSigningInfo and setSigningInfo
Returns
selection of signing parameters
const time::milliseconds& ndn::nfd::CommandOptions::getTimeout ( ) const
inline
Returns
command timeout

Definition at line 56 of file command-options.hpp.

CommandOptions & ndn::nfd::CommandOptions::setPrefix ( const Name &  prefix)

sets command prefix

Returns
self

Definition at line 53 of file command-options.cpp.

CommandOptions& ndn::nfd::CommandOptions::setSigningCertificate ( const Name &  certificateName)

chooses to use a specific identity certificate

Deprecated:
use getSigningInfo and setSigningInfo
Parameters
certificateNameidentity certificate Name
Exceptions
std::invalid_argumentif certificateName is invalid
Postcondition
getSigningParamsKind() == SIGNING_PARAMS_CERTIFICATE
getSigningCertificate() == certificateName
Returns
self
CommandOptions& ndn::nfd::CommandOptions::setSigningCertificate ( const security::v1::IdentityCertificate &  certificate)

chooses to use a specific identity certificate

Deprecated:
use getSigningInfo and setSigningInfo

This is equivalent to .setIdentityCertificate(certificate.getName())

CommandOptions& ndn::nfd::CommandOptions::setSigningDefault ( )

chooses to use default identity and certificate

Deprecated:
use getSigningInfo and setSigningInfo
Postcondition
getSigningParamsKind() == SIGNING_PARAMS_DEFAULT
Returns
self
CommandOptions& ndn::nfd::CommandOptions::setSigningIdentity ( const Name &  identityName)

chooses to use a specific identity and its default certificate

Deprecated:
use getSigningInfo and setSigningInfo
Postcondition
getSigningParamsKind() == SIGNING_PARAMS_IDENTITY
getIdentityName() == identityName
Returns
self
CommandOptions & ndn::nfd::CommandOptions::setSigningInfo ( const security::SigningInfo &  signingInfo)

sets signing parameters

Returns
self

Definition at line 60 of file command-options.cpp.

CommandOptions & ndn::nfd::CommandOptions::setTimeout ( const time::milliseconds &  timeout)

sets command timeout

Parameters
timeoutthe new command timeout, must be positive
Exceptions
std::out_of_rangeif timeout is non-positive
Returns
self

Definition at line 42 of file command-options.cpp.

Field Documentation

const Name ndn::nfd::CommandOptions::DEFAULT_PREFIX
static

gives the default command prefix: ndn:/localhost/nfd

Definition at line 185 of file command-options.hpp.

const time::milliseconds ndn::nfd::CommandOptions::DEFAULT_TIMEOUT
static

gives the default command timeout: 10000ms

Definition at line 181 of file command-options.hpp.