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...
void	validateRequest (const ControlParameters &parameters) const override
	validate request parameters More...
void	validateResponse (const ControlParameters &parameters) const override
Public Member Functions inherited from ndn::nfd::ControlCommand
virtual	~ControlCommand ()
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...

Additional Inherited Members
Protected Member Functions inherited from ndn::nfd::ControlCommand
	ControlCommand (const std::string &module, const std::string &verb)
Protected Attributes inherited from ndn::nfd::ControlCommand
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 163 of file control-command.hpp.

Constructor & Destructor Documentation

ndn::nfd::FaceUpdateCommand::FaceUpdateCommand

(

)

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

References ndn::nfd::CONTROL_PARAMETER_FACE_ID, ndn::nfd::CONTROL_PARAMETER_FACE_PERSISTENCY, ndn::nfd::CONTROL_PARAMETER_FLAGS, ndn::nfd::CONTROL_PARAMETER_MASK, ndn::nfd::ControlCommand::m_requestValidator, ndn::nfd::ControlCommand::m_responseValidator, ndn::nfd::ControlCommand::FieldValidator::optional(), and ndn::nfd::ControlCommand::FieldValidator::required().

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

References ndn::nfd::ControlParameters::hasFaceId(), and ndn::nfd::ControlParameters::setFaceId().

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

overridevirtual

validate request parameters

Exceptions

ArgumentError

if parameters are invalid

Reimplemented from ndn::nfd::ControlCommand.

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

References ndn::nfd::ControlParameters::hasFlags(), ndn::nfd::ControlParameters::hasMask(), and ndn::nfd::ControlCommand::validateRequest().

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

References ndn::nfd::ControlParameters::getFaceId(), ndn::nfd::INVALID_FACE_ID, and ndn::nfd::ControlCommand::validateResponse().

---

The documentation for this class was generated from the following files:

• ndnSIM/ndn-cxx/src/mgmt/nfd/control-command.hpp
• ndnSIM/ndn-cxx/src/mgmt/nfd/control-command.cpp