ndn::nfd::RibRegisterCommand Class Reference

represents a rib/register command More...

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

Inheritance diagram for ndn::nfd::RibRegisterCommand:

Collaboration diagram for ndn::nfd::RibRegisterCommand:

Public Member Functions
	RibRegisterCommand ()
void	applyDefaultsToRequest (ControlParameters &parameters) const override
	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...
void	validateResponse (const ControlParameters &parameters) const override
	validate response parameters More...

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

Detailed Description

represents a rib/register command

See also

https://redmine.named-data.net/projects/nfd/wiki/RibMgmt#Register-a-route

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

Constructor & Destructor Documentation

RibRegisterCommand()

ndn::nfd::RibRegisterCommand::RibRegisterCommand

(

)

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

Member Function Documentation

applyDefaultsToRequest()

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

overridevirtual

apply default values to missing fields in request

Reimplemented from ndn::nfd::ControlCommand.

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

applyDefaultsToResponse()

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

virtualinherited

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

inherited

construct the Name for a request Interest

Exceptions

ArgumentError

if parameters are invalid

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

validateRequest()

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

virtualinherited

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.

validateResponse()

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

overridevirtual

validate response parameters

Exceptions

ArgumentError

if parameters are invalid

Reimplemented from ndn::nfd::ControlCommand.

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

Member Data Documentation

m_requestValidator

FieldValidator ndn::nfd::ControlCommand::m_requestValidator

protectedinherited

FieldValidator for request ControlParameters.

Constructor of subclass should populate this validator.

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

m_responseValidator

FieldValidator ndn::nfd::ControlCommand::m_responseValidator

protectedinherited

FieldValidator for response ControlParameters.

Constructor of subclass should populate this validator.

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