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

provides access to NFD face management More...

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

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

Public Member Functions

void fetchStatus (Controller &controller, const function< void()> &onSuccess, const Controller::DatasetFailCallback &onFailure, const CommandOptions &options) override
 collect status from NFD More...
 
void formatItemXml (std::ostream &os, const FaceStatus &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...
 

Static Public Member Functions

static void create (ExecuteContext &ctx)
 the 'face create' command More...
 
static void destroy (ExecuteContext &ctx)
 the 'face destroy' command More...
 
static void formatItemText (std::ostream &os, const FaceStatus &item, bool wantMultiLine)
 format a single status item as text More...
 
static void list (ExecuteContext &ctx)
 the 'face list' command More...
 
static void registerCommands (CommandParser &parser)
 register 'face list', 'face show', 'face create', 'face destroy' commands More...
 
static void show (ExecuteContext &ctx)
 the 'face show' command More...
 

Detailed Description

provides access to NFD face management

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

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

Member Function Documentation

void nfd::tools::nfdc::FaceModule::create ( ExecuteContext ctx)
static

the 'face create' command

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

void nfd::tools::nfdc::FaceModule::destroy ( ExecuteContext ctx)
static

the 'face destroy' command

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

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 323 of file face-module.cpp.

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

format a single status item as text

Parameters
osoutput stream
itemstatus item
wantMultiLineuse multi-line style

Definition at line 410 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 347 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 399 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 337 of file face-module.cpp.

void nfd::tools::nfdc::FaceModule::list ( ExecuteContext ctx)
static

the 'face list' command

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

void nfd::tools::nfdc::FaceModule::registerCommands ( CommandParser parser)
static

register 'face list', 'face show', 'face create', 'face destroy' commands

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

void nfd::tools::nfdc::FaceModule::show ( ExecuteContext ctx)
static

the 'face show' command

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