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 (ndn::nfd::Controller &controller, const std::function< void()> &onSuccess, const ndn::nfd::DatasetFailureCallback &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 any member fields.

Definition at line 43 of file module.hpp.

Constructor & Destructor Documentation

◆ ~Module()

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

Member Function Documentation

◆ fetchStatus()

virtual void nfd::tools::nfdc::Module::fetchStatus ( ndn::nfd::Controller &  controller,
const std::function< void()> &  onSuccess,
const ndn::nfd::DatasetFailureCallback &  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::StrategyChoiceModule, nfd::tools::nfdc::RibModule, nfd::tools::nfdc::ForwarderGeneralModule, nfd::tools::nfdc::FibModule, nfd::tools::nfdc::FaceModule, nfd::tools::nfdc::CsModule, and nfd::tools::nfdc::ChannelModule.

◆ formatStatusText()

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

◆ formatStatusXml()

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