nfd::tools::nfdc::ForwarderGeneralModule Class Reference

Provides access to NFD forwarder general status. More...

#include <tools/nfdc/forwarder-general-module.hpp>

+ Inheritance diagram for nfd::tools::nfdc::ForwarderGeneralModule:
+ Collaboration diagram for nfd::tools::nfdc::ForwarderGeneralModule:

Public Member Functions

void fetchStatus (ndn::nfd::Controller &controller, const std::function< void()> &onSuccess, const ndn::nfd::DatasetFailureCallback &onFailure, const CommandOptions &options) override
 Collect status from NFD. More...
 
void formatStatusText (std::ostream &os) const override
 Format collected status as text. More...
 
void formatStatusXml (std::ostream &os) const override
 Format collected status as XML. More...
 

Static Public Member Functions

static void formatItemText (std::ostream &os, const ForwarderStatus &item)
 Format a single status item as text. More...
 
static void formatItemXml (std::ostream &os, const ForwarderStatus &item)
 Format a single status item as XML. More...
 

Detailed Description

Provides access to NFD forwarder general status.

See also
https://redmine.named-data.net/projects/nfd/wiki/ForwarderStatus

Definition at line 41 of file forwarder-general-module.hpp.

Member Function Documentation

◆ fetchStatus()

void nfd::tools::nfdc::ForwarderGeneralModule::fetchStatus ( ndn::nfd::Controller &  controller,
const std::function< void()> &  onSuccess,
const ndn::nfd::DatasetFailureCallback &  onFailure,
const CommandOptions &  options 
)
overridevirtual

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

Implements nfd::tools::nfdc::Module.

Definition at line 35 of file forwarder-general-module.cpp.

◆ formatItemText()

void nfd::tools::nfdc::ForwarderGeneralModule::formatItemText ( std::ostream &  os,
const ForwarderStatus &  item 
)
static

Format a single status item as text.

Parameters
osoutput stream
itemstatus item

Definition at line 105 of file forwarder-general-module.cpp.

◆ formatItemXml()

void nfd::tools::nfdc::ForwarderGeneralModule::formatItemXml ( std::ostream &  os,
const ForwarderStatus &  item 
)
static

Format a single status item as XML.

Parameters
osoutput stream
itemstatus item

Definition at line 61 of file forwarder-general-module.cpp.

◆ formatStatusText()

void nfd::tools::nfdc::ForwarderGeneralModule::formatStatusText ( std::ostream &  os) const
overridevirtual

Format collected status as text.

Precondition
fetchStatus has been successful
Parameters
osoutput stream

Implements nfd::tools::nfdc::Module.

Definition at line 97 of file forwarder-general-module.cpp.

◆ formatStatusXml()

void nfd::tools::nfdc::ForwarderGeneralModule::formatStatusXml ( std::ostream &  os) const
overridevirtual

Format collected status as XML.

Precondition
fetchStatus has been successful
Parameters
osoutput stream

Implements nfd::tools::nfdc::Module.

Definition at line 55 of file forwarder-general-module.cpp.