ndn::nfd::ControlCommand Class Reference

base class of NFD ControlCommand More...

#include <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	validateRequest (const ControlParameters &parameters) const
	validate request parameters More...
virtual void	applyDefaultsToRequest (ControlParameters &parameters) const
	apply default values to missing fields in request More...
virtual void	validateResponse (const ControlParameters &parameters) const
	validate response parameters 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...

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

base class of NFD ControlCommand

See also

https://redmine.named-data.net/projects/nfd/wiki/ControlCommand

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

Constructor & Destructor Documentation

~ControlCommand()

ndn::nfd::ControlCommand::~ControlCommand ( )

virtualdefault

ControlCommand()

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

validateRequest()

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

virtual

validate request parameters

Exceptions

ArgumentError

if parameters are invalid

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

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

References m_requestValidator, and ndn::nfd::ControlCommand::FieldValidator::validate().

Referenced by getRequestName(), ndn::nfd::FaceDestroyCommand::validateRequest(), ndn::nfd::CsEraseCommand::validateRequest(), and ndn::nfd::StrategyChoiceUnsetCommand::validateRequest().

applyDefaultsToRequest()

void ndn::nfd::ControlCommand::applyDefaultsToRequest ( ControlParameters &  parameters ) const

virtual

apply default values to missing fields in request

Reimplemented in ndn::nfd::RibUnregisterCommand, ndn::nfd::RibRegisterCommand, ndn::nfd::FibRemoveNextHopCommand, ndn::nfd::FibAddNextHopCommand, ndn::nfd::FaceUpdateCommand, and ndn::nfd::FaceCreateCommand.

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

validateResponse()

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

virtual

validate response parameters

Exceptions

ArgumentError

if parameters are invalid

Reimplemented in ndn::nfd::RibUnregisterCommand, ndn::nfd::RibRegisterCommand, ndn::nfd::StrategyChoiceUnsetCommand, ndn::nfd::CsEraseCommand, ndn::nfd::FibRemoveNextHopCommand, ndn::nfd::FibAddNextHopCommand, ndn::nfd::FaceDestroyCommand, ndn::nfd::FaceUpdateCommand, and ndn::nfd::FaceCreateCommand.

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

References m_responseValidator, and ndn::nfd::ControlCommand::FieldValidator::validate().

Referenced by ndn::nfd::FaceCreateCommand::validateResponse(), ndn::nfd::FaceUpdateCommand::validateResponse(), ndn::nfd::FibAddNextHopCommand::validateResponse(), ndn::nfd::FibRemoveNextHopCommand::validateResponse(), ndn::nfd::CsEraseCommand::validateResponse(), ndn::nfd::RibRegisterCommand::validateResponse(), and ndn::nfd::RibUnregisterCommand::validateResponse().

applyDefaultsToResponse()

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.

getRequestName()

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

construct the Name for a request Interest

Exceptions

ArgumentError

if parameters are invalid

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

References validateRequest(), and ndn::nfd::ControlParameters::wireEncode().

Member Data Documentation

m_requestValidator

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.

Referenced by ndn::nfd::CsConfigCommand::CsConfigCommand(), ndn::nfd::CsEraseCommand::CsEraseCommand(), ndn::nfd::FaceCreateCommand::FaceCreateCommand(), ndn::nfd::FaceDestroyCommand::FaceDestroyCommand(), ndn::nfd::FaceUpdateCommand::FaceUpdateCommand(), ndn::nfd::FibAddNextHopCommand::FibAddNextHopCommand(), ndn::nfd::FibRemoveNextHopCommand::FibRemoveNextHopCommand(), ndn::nfd::RibRegisterCommand::RibRegisterCommand(), ndn::nfd::RibUnregisterCommand::RibUnregisterCommand(), ndn::nfd::StrategyChoiceSetCommand::StrategyChoiceSetCommand(), ndn::nfd::StrategyChoiceUnsetCommand::StrategyChoiceUnsetCommand(), and validateRequest().

m_responseValidator

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.

Referenced by ndn::nfd::CsConfigCommand::CsConfigCommand(), ndn::nfd::CsEraseCommand::CsEraseCommand(), ndn::nfd::FaceCreateCommand::FaceCreateCommand(), ndn::nfd::FaceDestroyCommand::FaceDestroyCommand(), ndn::nfd::FaceUpdateCommand::FaceUpdateCommand(), ndn::nfd::FibAddNextHopCommand::FibAddNextHopCommand(), ndn::nfd::FibRemoveNextHopCommand::FibRemoveNextHopCommand(), ndn::nfd::RibRegisterCommand::RibRegisterCommand(), ndn::nfd::RibUnregisterCommand::RibUnregisterCommand(), ndn::nfd::StrategyChoiceSetCommand::StrategyChoiceSetCommand(), ndn::nfd::StrategyChoiceUnsetCommand::StrategyChoiceUnsetCommand(), and validateResponse().

---

The documentation for this class was generated from the following files:

• ndnSIM/ndn-cxx/ndn-cxx/mgmt/nfd/control-command.hpp
• ndnSIM/ndn-cxx/ndn-cxx/mgmt/nfd/control-command.cpp