nfd::tools::nfdc::StatusReport Class Reference

collects and prints NFD status report More...

#include <tools/nfdc/status-report.hpp>

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

Public Member Functions

uint32_t collect (Face &face, KeyChain &keyChain, Validator &validator, const CommandOptions &options)
 collect status via chosen sections More...
 
void formatText (std::ostream &os) const
 print a text report More...
 
void formatXml (std::ostream &os) const
 print an XML report More...
 

Public Attributes

std::vector< unique_ptr< Module > > sections
 modules through which status is collected More...
 

Detailed Description

collects and prints NFD status report

Definition at line 55 of file status-report.hpp.

Member Function Documentation

uint32_t nfd::tools::nfdc::StatusReport::collect ( Face &  face,
KeyChain &  keyChain,
Validator &  validator,
const CommandOptions &  options 
)

collect status via chosen sections

This function is blocking. It has exclusive use of face.

Returns
if status has been fetched successfully, 0; otherwise, error code from any failed section, plus 1000000 * section index

Definition at line 58 of file status-report.cpp.

void nfd::tools::nfdc::StatusReport::formatText ( std::ostream &  os) const

print a text report

Parameters
osoutput stream

Definition at line 95 of file status-report.cpp.

void nfd::tools::nfdc::StatusReport::formatXml ( std::ostream &  os) const

print an XML report

Parameters
osoutput stream

Definition at line 85 of file status-report.cpp.

Member Data Documentation

std::vector<unique_ptr<Module> > nfd::tools::nfdc::StatusReport::sections

modules through which status is collected

Definition at line 92 of file status-report.hpp.