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 291 of file control-command.hpp.

Constructor & Destructor Documentation

RibRegisterCommand()

ndn::nfd::RibRegisterCommand::RibRegisterCommand

(

)

Definition at line 341 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 361 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 52 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 57 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 35 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 378 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 119 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 124 of file control-command.hpp.