nfd::tools::nfdc::FaceModule Class Reference

provides access to NFD face management More...

#include <face-module.hpp>

Inheritance diagram for nfd::tools::nfdc::FaceModule:
Collaboration diagram for nfd::tools::nfdc::FaceModule:

Public Member Functions

virtual void fetchStatus (Controller &controller, const function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
 collect status from NFD More...
 
virtual void formatStatusXml (std::ostream &os) const override
 format collected status as XML More...
 
void formatItemXml (std::ostream &os, const FaceStatus &item) 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 FaceStatus &item) const
 format a single status item as text More...
 

Detailed Description

provides access to NFD face management

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

Definition at line 40 of file face-module.hpp.

Member Function Documentation

void nfd::tools::nfdc::FaceModule::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
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 54 of file face-module.cpp.

void nfd::tools::nfdc::FaceModule::formatItemText ( std::ostream &  os,
const FaceStatus &  item 
) const

format a single status item as text

Parameters
osoutput stream
itemstatus item

Definition at line 136 of file face-module.cpp.

void nfd::tools::nfdc::FaceModule::formatItemXml ( std::ostream &  os,
const FaceStatus &  item 
) const

format a single status item as XML

Parameters
osoutput stream
itemstatus item

Definition at line 78 of file face-module.cpp.

void nfd::tools::nfdc::FaceModule::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 127 of file face-module.cpp.

void nfd::tools::nfdc::FaceModule::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 68 of file face-module.cpp.