ndn::nfd::StatusDataset Class Reference

base class of NFD StatusDataset More...

#include <ndn-cxx/mgmt/nfd/status-dataset.hpp>

Inheritance diagram for ndn::nfd::StatusDataset:

Collaboration diagram for ndn::nfd::StatusDataset:

Classes
class	ParseResultError
	indicates reassembled payload cannot be parsed as ResultType More...

Public Types
using	ParamType = int
	if defined, specifies constructor argument type; otherwise, constructor has no argument More...
using	ResultType = std::vector< int >
	provides the result type, usually a vector More...

Public Member Functions
virtual	~StatusDataset ()
Name	getDatasetPrefix (const Name &prefix) const
	constructs a name prefix for the dataset More...
ResultType	parseResult (ConstBufferPtr payload) const
	parses a result from reassembled payload More...

Protected Member Functions
	StatusDataset (const PartialName &datasetName)
	constructs a StatusDataset instance with given sub-prefix More...

Detailed Description

base class of NFD StatusDataset

See also

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

Definition at line 43 of file status-dataset.hpp.

Member Typedef Documentation

ParamType

using ndn::nfd::StatusDataset::ParamType = int

if defined, specifies constructor argument type; otherwise, constructor has no argument

Definition at line 54 of file status-dataset.hpp.

ResultType

using ndn::nfd::StatusDataset::ResultType = std::vector<int>

provides the result type, usually a vector

Definition at line 69 of file status-dataset.hpp.

Constructor & Destructor Documentation

~StatusDataset()

ndn::nfd::StatusDataset::~StatusDataset ( )

virtualdefault

StatusDataset()

ndn::nfd::StatusDataset::StatusDataset ( const PartialName &  datasetName )

explicitprotected

constructs a StatusDataset instance with given sub-prefix

Parameters

datasetName

dataset name after top-level prefix, such as faces/list

Definition at line 28 of file status-dataset.cpp.

Member Function Documentation

getDatasetPrefix()

Name ndn::nfd::StatusDataset::getDatasetPrefix

(

const Name &

prefix

)

const

constructs a name prefix for the dataset

Parameters

prefix

top-level prefix, such as ndn:/localhost/nfd

Returns

name prefix without version and segment components

Definition at line 36 of file status-dataset.cpp.

parseResult()

ResultType ndn::nfd::StatusDataset::parseResult

(

ConstBufferPtr

payload

)

const

parses a result from reassembled payload

Parameters

payload

reassembled payload

Exceptions

tlv::Error

cannot parse payload