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

provides access to NFD forwarder general status More...

#include <forwarder-general-module.hpp>

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

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

Public Member Functions
	ForwarderGeneralModule ()
virtual void	fetchStatus (Controller &controller, const function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
	collect status from NFD More...
void	setNfdIdCollector (const NfdIdCollector &nfdIdCollector)
virtual void	formatStatusXml (std::ostream &os) const override
	format collected status as XML More...
void	formatItemXml (std::ostream &os, const ForwarderStatus &item, const Name &nfdId) const
	format a single status item as XML More...
virtual void	formatStatusText (std::ostream &os) const override
	format collected status as text More...
void	formatItemText (std::ostream &os, const ForwarderStatus &item, const Name &nfdId) const
	format a single status item as text More...

Detailed Description

provides access to NFD forwarder general status

See also

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

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

Constructor & Destructor Documentation

nfd::tools::nfdc::ForwarderGeneralModule::ForwarderGeneralModule

(

)

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

Member Function Documentation

void nfd::tools::nfdc::ForwarderGeneralModule::fetchStatus ( Controller &  controller, const 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 39 of file forwarder-general-module.cpp.

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

format a single status item as text

Parameters

os	output stream
item	status item
nfdId	NFD's signing certificate name

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

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

format a single status item as XML

Parameters

os	output stream
item	status item
nfdId	NFD's signing certificate name

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

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 110 of file forwarder-general-module.cpp.

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 70 of file forwarder-general-module.cpp.

void nfd::tools::nfdc::ForwarderGeneralModule::setNfdIdCollector ( const NfdIdCollector &  nfdIdCollector )

inline

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