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 (Controller &controller, const std::function< void()> &onSuccess, const Controller::DatasetFailCallback &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 38 of file forwarder-general-module.hpp.

Member Function Documentation

fetchStatus()

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

overridevirtual

Collect status from NFD.

Precondition

no other fetchStatus is in progress

Parameters

controller	a controller through which StatusDataset can be requested
onSuccess	invoked when status has been collected into this instance
onFailure	passed to controller.fetch
options	passed to controller.fetch

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

Definition at line 34 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

os	output stream
item	status item

Definition at line 104 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

os	output stream
item	status item

Definition at line 60 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

os	output stream

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

Definition at line 96 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

os	output stream

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

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