Represents a faces/update command. More...

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

Inheritance diagram for ndn::nfd::FaceUpdateCommand:

Collaboration diagram for ndn::nfd::FaceUpdateCommand:

Public Member Functions
	FaceUpdateCommand ()

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

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

FieldValidator	m_responseValidator
	FieldValidator for response ControlParameters. More...

Detailed Description

Represents a faces/update command.

See also: https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Update-the-static-properties-of-a-face

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

Constructor & Destructor Documentation

◆ FaceUpdateCommand()

ndn::nfd::FaceUpdateCommand::FaceUpdateCommand ( )

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

Member Function Documentation

◆ applyDefaultsToRequest()

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

overridevirtual

Apply default values to missing fields in request.

Reimplemented from ndn::nfd::ControlCommand.

Definition at line 161 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::FaceUpdateCommand::validateResponse ( const ControlParameters & parameters ) const

overridevirtual

Note: This can only validate ControlParameters in a success response. Failure responses should be validated with validateRequest.

Reimplemented from ndn::nfd::ControlCommand.

Definition at line 169 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 120 of file control-command.hpp.

◆ m_responseValidator

FieldValidator ndn::nfd::ControlCommand::m_responseValidator