ndn::nfd::ControlCommand Class Reference

base class of NFD ControlCommand More...

#include <nfd-control-command.hpp>

Inheritance diagram for ndn::nfd::ControlCommand:

Collaboration diagram for ndn::nfd::ControlCommand:

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

Public Member Functions
const Name &	getPrefix () const
Interest	makeCommandInterest (const ControlParameters &parameters, CommandInterestGenerator &commandInterestGenerator) const
	make a Command Interest from parameters More...
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...

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

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

Definition at line 19 of file nfd-control-command.hpp.

Constructor & Destructor Documentation

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

inlineprotected

Definition at line 90 of file nfd-control-command.hpp.

Member Function Documentation

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

inlinevirtual

apply default values to missing fields in request

Reimplemented in ndn::nfd::RibUnregisterCommand, ndn::nfd::RibRegisterCommand, and ndn::nfd::FibAddNextHopCommand.

Definition at line 69 of file nfd-control-command.hpp.

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

inlinevirtual

apply default values to missing fields in response

Definition at line 85 of file nfd-control-command.hpp.

const Name& ndn::nfd::ControlCommand::getPrefix ( ) const

inline

Returns

Name prefix of this ControlCommand

Definition at line 37 of file nfd-control-command.hpp.

Interest ndn::nfd::ControlCommand::makeCommandInterest ( const ControlParameters &  parameters, CommandInterestGenerator &  commandInterestGenerator  ) const

inline

make a Command Interest from parameters

Definition at line 45 of file nfd-control-command.hpp.

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

inlinevirtual

validate request parameters

Exceptions

ArgumentError

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

Definition at line 61 of file nfd-control-command.hpp.

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

inlinevirtual

validate response parameters

Exceptions

ArgumentError

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

Definition at line 77 of file nfd-control-command.hpp.

Field Documentation

FieldValidator ndn::nfd::ControlCommand::m_requestValidator

protected

FieldValidator for request ControlParameters.

Constructor of subclass should populate this validator.

Definition at line 155 of file nfd-control-command.hpp.

FieldValidator ndn::nfd::ControlCommand::m_responseValidator

protected

FieldValidator for response ControlParameters.

Constructor of subclass should populate this validator.

Definition at line 160 of file nfd-control-command.hpp.