ndn::nfd::FaceLocalControlCommand Class Reference

Base class for faces/[*]-local-control commands. More...

#include <control-command.hpp>

Inheritance diagram for ndn::nfd::FaceLocalControlCommand:
[legend]
Collaboration diagram for ndn::nfd::FaceLocalControlCommand:
[legend]

Public Member Functions

void validateRequest (const ControlParameters &parameters) const override
 validate request parameters More...
 
void validateResponse (const ControlParameters &parameters) const override
 validate response parameters More...
 
virtual void applyDefaultsToRequest (ControlParameters &parameters) const
 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...
 

Protected Member Functions

 FaceLocalControlCommand (const std::string &verb)
 

Protected Attributes

FieldValidator m_requestValidator
 FieldValidator for request ControlParameters. More...
 
FieldValidator m_responseValidator
 FieldValidator for response ControlParameters. More...
 

Detailed Description

Base class for faces/[*]-local-control commands.

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

Constructor & Destructor Documentation

ndn::nfd::FaceLocalControlCommand::FaceLocalControlCommand ( const std::string &  verb)
explicitprotected

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

Member Function Documentation

void ndn::nfd::ControlCommand::applyDefaultsToRequest ( ControlParameters parameters) const
virtualinherited
void ndn::nfd::ControlCommand::applyDefaultsToResponse ( ControlParameters parameters) const
virtualinherited

apply default values to missing fields in response

Definition at line 54 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 59 of file control-command.cpp.

void ndn::nfd::FaceLocalControlCommand::validateRequest ( const ControlParameters parameters) const
overridevirtual

validate request parameters

Exceptions
ArgumentErrorif parameters are invalid

Reimplemented from ndn::nfd::ControlCommand.

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

void ndn::nfd::FaceLocalControlCommand::validateResponse ( const ControlParameters parameters) const
overridevirtual

validate response parameters

Exceptions
ArgumentErrorif parameters are invalid

Reimplemented from ndn::nfd::ControlCommand.

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

Field 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.