ndn::nfd::StatusDatasetBase Class Reference

Base class of NFD StatusDataset. More...

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

Inheritance diagram for ndn::nfd::StatusDatasetBase:

Collaboration diagram for ndn::nfd::StatusDatasetBase:

Public Member Functions
Name	getDatasetPrefix (const Name &prefix) const
	Constructs a name prefix for the dataset. More...
ResultType	parseResult (ConstBufferPtr payload) const
	Parses a result from a reassembled payload. More...

Protected Member Functions
	StatusDatasetBase (PartialName datasetName)
	Protected constructor. More...
	~StatusDatasetBase ()=default

Protected Attributes
PartialName	m_datasetName

Detailed Description

Base class of NFD StatusDataset.

See also

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

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

Constructor & Destructor Documentation

StatusDatasetBase()

ndn::nfd::StatusDatasetBase::StatusDatasetBase ( PartialName  datasetName )

inlineexplicitprotected

Protected constructor.

Parameters

datasetName

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

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

~StatusDatasetBase()

ndn::nfd::StatusDatasetBase::~StatusDatasetBase ( )

protecteddefault

Member Function Documentation

getDatasetPrefix()

Name ndn::nfd::StatusDatasetBase::getDatasetPrefix

(

const Name &

prefix

)

const

Constructs a name prefix for the dataset.

Parameters

prefix

Top-level prefix, such as /localhost/nfd.

Returns

Name prefix without version and segment components.

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

parseResult()

ResultType ndn::nfd::StatusDatasetBase::parseResult

(

ConstBufferPtr

payload

)

const

Parses a result from a reassembled payload.

Parameters

payload

The reassembled payload.

Returns

The parsed result, usually a vector.

Exceptions

tlv::Error

Cannot parse the payload.

See also

StatusDatasetParseError

Member Data Documentation

m_datasetName

PartialName ndn::nfd::StatusDatasetBase::m_datasetName

protected

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