nfd::tools::nfdc::ChannelModule Class Reference

Provides access to NFD channel dataset. More...

#include <tools/nfdc/channel-module.hpp>

Inheritance diagram for nfd::tools::nfdc::ChannelModule:

Collaboration diagram for nfd::tools::nfdc::ChannelModule:

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	formatItemText (std::ostream &os, const ChannelStatus &item) const
	Format a single status item as text. More...
void	formatItemXml (std::ostream &os, const ChannelStatus &item) const
	Format a single status item as XML. 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...

Detailed Description

Provides access to NFD channel dataset.

See also

https://redmine.named-data.net/projects/nfd/wiki/FaceMgmt#Channel-Dataset

Definition at line 41 of file channel-module.hpp.

Member Function Documentation

fetchStatus()

void nfd::tools::nfdc::ChannelModule::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

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 channel-module.cpp.

formatItemText()

void nfd::tools::nfdc::ChannelModule::formatItemText	(	std::ostream &	os,
		const ChannelStatus &	item
	)		const

Format a single status item as text.

Parameters

os	output stream
item	status item

Definition at line 75 of file channel-module.cpp.

formatItemXml()

void nfd::tools::nfdc::ChannelModule::formatItemXml	(	std::ostream &	os,
		const ChannelStatus &	item
	)		const

Format a single status item as XML.

Parameters

os	output stream
item	status item

Definition at line 58 of file channel-module.cpp.

formatStatusText()

void nfd::tools::nfdc::ChannelModule::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 66 of file channel-module.cpp.

formatStatusXml()

void nfd::tools::nfdc::ChannelModule::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 48 of file channel-module.cpp.