ndn::nfd::RibRegisterCommand Class Reference

represents a rib/register command More...

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

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

References ndn::nfd::CONTROL_PARAMETER_COST, ndn::nfd::CONTROL_PARAMETER_EXPIRATION_PERIOD, ndn::nfd::CONTROL_PARAMETER_FACE_ID, ndn::nfd::CONTROL_PARAMETER_FLAGS, ndn::nfd::CONTROL_PARAMETER_NAME, ndn::nfd::CONTROL_PARAMETER_ORIGIN, ndn::nfd::ControlCommand::m_requestValidator, ndn::nfd::ControlCommand::m_responseValidator, ndn::nfd::ControlCommand::FieldValidator::optional(), and ndn::nfd::ControlCommand::FieldValidator::required().

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

References ndn::nfd::ControlParameters::hasCost(), ndn::nfd::ControlParameters::hasFaceId(), ndn::nfd::ControlParameters::hasFlags(), ndn::nfd::ControlParameters::hasOrigin(), ndn::nfd::ROUTE_FLAG_CHILD_INHERIT, ndn::nfd::ROUTE_ORIGIN_APP, ndn::nfd::ControlParameters::setCost(), ndn::nfd::ControlParameters::setFaceId(), ndn::nfd::ControlParameters::setFlags(), and ndn::nfd::ControlParameters::setOrigin().

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

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

---

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

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