ndn::nfd::ControlCommand Class Reference

base class of NFD ControlCommand More...

#include <ndn-cxx/mgmt/nfd/control-command.hpp>

+ Inheritance diagram for ndn::nfd::ControlCommand:
+ Collaboration diagram for ndn::nfd::ControlCommand:

Classes

class  ArgumentError
 represents an error in ControlParameters More...
 
class  FieldValidator
 

Public Member Functions

virtual ~ControlCommand ()
 
virtual void applyDefaultsToRequest (ControlParameters &parameters) const
 apply default values to missing fields in request More...
 
virtual void applyDefaultsToResponse (ControlParameters &parameters) const
 apply default values to missing fields in response More...
 
Name getRequestName (const Name &commandPrefix, const ControlParameters &parameters) const
 construct the Name for a request Interest More...
 
virtual void validateRequest (const ControlParameters &parameters) const
 validate request parameters More...
 
virtual void validateResponse (const ControlParameters &parameters) const
 validate response parameters More...
 

Protected Member Functions

 ControlCommand (const std::string &module, const std::string &verb)
 

Protected Attributes

FieldValidator m_requestValidator
 FieldValidator for request ControlParameters. More...
 
FieldValidator m_responseValidator
 FieldValidator for response ControlParameters. More...
 

Detailed Description

Constructor & Destructor Documentation

ndn::nfd::ControlCommand::~ControlCommand ( )
virtualdefault
ndn::nfd::ControlCommand::ControlCommand ( const std::string &  module,
const std::string &  verb 
)
protected

Definition at line 27 of file control-command.cpp.

Member Function Documentation

void ndn::nfd::ControlCommand::applyDefaultsToRequest ( ControlParameters parameters) const
virtual
void ndn::nfd::ControlCommand::applyDefaultsToResponse ( ControlParameters parameters) const
virtual

apply default values to missing fields in response

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

Name ndn::nfd::ControlCommand::getRequestName ( const Name commandPrefix,
const ControlParameters parameters 
) const

construct the Name for a request Interest

Exceptions
ArgumentErrorif parameters are invalid

Definition at line 58 of file control-command.cpp.

void ndn::nfd::ControlCommand::validateRequest ( const ControlParameters parameters) const
virtual

validate request parameters

Exceptions
ArgumentErrorif parameters are invalid

Reimplemented in ndn::nfd::StrategyChoiceUnsetCommand, ndn::nfd::CsEraseCommand, and ndn::nfd::FaceDestroyCommand.

Definition at line 36 of file control-command.cpp.

void ndn::nfd::ControlCommand::validateResponse ( const ControlParameters parameters) const
virtual

Member Data Documentation

FieldValidator ndn::nfd::ControlCommand::m_requestValidator
protected

FieldValidator for request ControlParameters.

Constructor of subclass should populate this validator.

Definition at line 124 of file control-command.hpp.

FieldValidator ndn::nfd::ControlCommand::m_responseValidator
protected

FieldValidator for response ControlParameters.

Constructor of subclass should populate this validator.

Definition at line 129 of file control-command.hpp.