NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::nfd::ControlCommand Class Reference

base class of NFD ControlCommand More...

#include <control-command.hpp>

Inheritance diagram for ndn::nfd::ControlCommand:
Collaboration diagram for ndn::nfd::ControlCommand:


class  ArgumentError
 represents an error in ControlParameters More...
class  FieldValidator

Public Member Functions

virtual ~ControlCommand ()
virtual void validateRequest (const ControlParameters &parameters) const
 validate request parameters More...
virtual void applyDefaultsToRequest (ControlParameters &parameters) const
 apply default values to missing fields in request More...
virtual void validateResponse (const ControlParameters &parameters) const
 validate response 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...

Protected Member Functions

 ControlCommand (const std::string &module, const std::string &verb)

Protected Attributes

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

Detailed Description

Constructor & Destructor Documentation

◆ ~ControlCommand()

ndn::nfd::ControlCommand::~ControlCommand ( )

◆ ControlCommand()

ndn::nfd::ControlCommand::ControlCommand ( const std::string &  module,
const std::string &  verb 

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

Member Function Documentation

◆ validateRequest()

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

◆ applyDefaultsToRequest()

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

◆ validateResponse()

◆ applyDefaultsToResponse()

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

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

construct the Name for a request Interest

ArgumentErrorif parameters are invalid

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

References validateRequest(), and ndn::nfd::ControlParameters::wireEncode().

Member Data Documentation

◆ m_requestValidator

◆ m_responseValidator

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