ndn::nfd::FaceUpdateCommand Class Reference

represents a faces/update command More...

#include <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-a-face

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

Constructor & Destructor Documentation

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

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

Member Function Documentation

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 157 of file control-command.cpp.

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.

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

construct the Name for a request Interest

Exceptions
ArgumentErrorif parameters are invalid

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

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

validate request parameters

Exceptions
ArgumentErrorif parameters are invalid

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

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

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 165 of file control-command.cpp.

Member Data Documentation

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.

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.