nfd::tools::nfdc::Module Class Referenceabstract

provides access to an NFD management module More...

#include <tools/nfdc/module.hpp>

+ Inheritance diagram for nfd::tools::nfdc::Module:

Public Member Functions

virtual ~Module ()=default
 
virtual void fetchStatus (Controller &controller, const function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options)=0
 collect status from NFD More...
 
virtual void formatStatusText (std::ostream &os) const =0
 format collected status as text More...
 
virtual void formatStatusXml (std::ostream &os) const =0
 format collected status as XML More...
 

Detailed Description

provides access to an NFD management module

Note
This type is an interface. It should not have member fields.

Definition at line 43 of file module.hpp.

Constructor & Destructor Documentation

virtual nfd::tools::nfdc::Module::~Module ( )
virtualdefault

Member Function Documentation

virtual void nfd::tools::nfdc::Module::fetchStatus ( Controller &  controller,
const function< void()> &  onSuccess,
const Controller::DatasetFailCallback &  onFailure,
const CommandOptions &  options 
)
pure virtual

collect status from NFD

Precondition
no other fetchStatus is in progress
Parameters
controllera controller through which StatusDataset can be requested
onSuccessinvoked when status has been collected into this instance
onFailurepassed to controller.fetch
optionspassed to controller.fetch

Implemented in nfd::tools::nfdc::RibModule, nfd::tools::nfdc::FaceModule, nfd::tools::nfdc::StrategyChoiceModule, nfd::tools::nfdc::FibModule, nfd::tools::nfdc::ChannelModule, and nfd::tools::nfdc::ForwarderGeneralModule.

virtual void nfd::tools::nfdc::Module::formatStatusText ( std::ostream &  os) const
pure virtual

format collected status as text

Precondition
fetchStatus has been successful
Parameters
osoutput stream

Implemented in nfd::tools::nfdc::FaceModule, nfd::tools::nfdc::StrategyChoiceModule, nfd::tools::nfdc::RibModule, nfd::tools::nfdc::FibModule, nfd::tools::nfdc::ChannelModule, and nfd::tools::nfdc::ForwarderGeneralModule.

virtual void nfd::tools::nfdc::Module::formatStatusXml ( std::ostream &  os) const
pure virtual

format collected status as XML

Precondition
fetchStatus has been successful
Parameters
osoutput stream

Implemented in nfd::tools::nfdc::RibModule, nfd::tools::nfdc::FaceModule, nfd::tools::nfdc::StrategyChoiceModule, nfd::tools::nfdc::FibModule, nfd::tools::nfdc::ChannelModule, and nfd::tools::nfdc::ForwarderGeneralModule.