ndn::mgmt::StatusDatasetContext Class Reference

Provides a context for generating the response to a StatusDataset request. More...

#include <status-dataset-context.hpp>

Inheritance diagram for ndn::mgmt::StatusDatasetContext:

Collaboration diagram for ndn::mgmt::StatusDatasetContext:

Public Types
using	NackSender = std::function< void(const ControlResponse &)>

Public Member Functions
const Name &	getPrefix () const
	Returns the prefix of Data packets, with version component but without segment component. More...
StatusDatasetContext &	setPrefix (const Name &prefix)
	Changes the prefix of the response Data packets. More...
void	append (span< const uint8_t > bytes)
	Appends a sequence of bytes to the response. More...
void	end ()
	Finalizes the response successfully after appending zero or more blocks. More...
void	reject (const ControlResponse &resp=ControlResponse().setCode(400))
	Rejects the request. More...
	StatusDatasetContext (const Interest &interest, DataSender dataSender, NackSender nackSender)

Public Attributes
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: using DataSender = std::function<void(const Name& dataName
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block &	content
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block bool	isFinalBlock

Friends
class	Dispatcher

Detailed Description

Provides a context for generating the response to a StatusDataset request.

Definition at line 34 of file status-dataset-context.hpp.

Member Typedef Documentation

NackSender

using ndn::mgmt::StatusDatasetContext::NackSender = std::function<void(const ControlResponse&)>

Definition at line 90 of file status-dataset-context.hpp.

Constructor & Destructor Documentation

StatusDatasetContext()

ndn::mgmt::StatusDatasetContext::StatusDatasetContext	(	const Interest &	interest,
		DataSender	dataSender,
		NackSender	nackSender
	)

Definition at line 29 of file status-dataset-context.cpp.

References ndn::Interest::getName(), and setPrefix().

Member Function Documentation

getPrefix()

const Name& ndn::mgmt::StatusDatasetContext::getPrefix ( ) const

inline

Returns the prefix of Data packets, with version component but without segment component.

Definition at line 41 of file status-dataset-context.hpp.

References append(), end(), NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE, reject(), and setPrefix().

setPrefix()

StatusDatasetContext & ndn::mgmt::StatusDatasetContext::setPrefix

(

const Name &

prefix

)

Changes the prefix of the response Data packets.

Parameters

prefix

the prefix; it must start with the Interest Name, may contain a version component, but must not contain a segment component

StatusDatasetHandler may change the prefix of Data packets with this method, before sending any response.

The version component is optional, and will be generated from the current timestamp if omitted.

Exceptions

std::invalid_argument	prefix does not satisfy the requirements
std::logic_error	append(), end(), or reject() has already been invoked

Definition at line 40 of file status-dataset-context.cpp.

References ndn::Name::appendVersion(), ndn::Name::at(), ndn::Interest::getName(), ndn::Name::isPrefixOf(), ndn::name::Component::isSegment(), ndn::name::Component::isVersion(), and NDN_THROW.

Referenced by getPrefix(), and StatusDatasetContext().

append()

void ndn::mgmt::StatusDatasetContext::append

(

span< const uint8_t >

bytes

)

Appends a sequence of bytes to the response.

Exceptions

std::logic_error

end() or reject() has already been invoked

Definition at line 63 of file status-dataset-context.cpp.

References ndn::tlv::Content, ndn::encoding::makeBinaryBlock(), ndn::mgmt::MAX_PAYLOAD_LENGTH, ns3::ndn::Name, and NDN_THROW.

Referenced by nfd::CsManager::CsManager(), nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), nfd::ForwarderStatusManager::ForwarderStatusManager(), getPrefix(), nfd::makeFaceStatus(), and nfd::matchFilter().

end()

void ndn::mgmt::StatusDatasetContext::end

(

)

Finalizes the response successfully after appending zero or more blocks.

Exceptions

std::logic_error

reject() has already been invoked

Definition at line 85 of file status-dataset-context.cpp.

References ndn::tlv::Content, ndn::encoding::makeBinaryBlock(), ndn::mgmt::MAX_PAYLOAD_LENGTH, ns3::ndn::Name, and NDN_THROW.

Referenced by nfd::CsManager::CsManager(), nfd::RibManager::enableLocalFields(), nfd::FibManager::FibManager(), nfd::ForwarderStatusManager::ForwarderStatusManager(), getPrefix(), nfd::makeFaceStatus(), and nfd::matchFilter().

reject()

void ndn::mgmt::StatusDatasetContext::reject

(

const ControlResponse &

resp = ControlResponse().setCode(400)

)

Rejects the request.

Parameters

resp	Content of producer-generated NACK

This should be invoked when the incoming Interest is malformed. A producer-generated NACK will be returned to the requester.

Exceptions

std::logic_error

append() or end() has already been invoked

Definition at line 99 of file status-dataset-context.cpp.

References NDN_THROW.

Referenced by getPrefix(), and nfd::matchFilter().

Friends And Related Function Documentation

Dispatcher

friend class Dispatcher

friend

Definition at line 95 of file status-dataset-context.hpp.

Member Data Documentation

__pad0__

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE ndn::mgmt::StatusDatasetContext::__pad0__

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

content

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block& ndn::mgmt::StatusDatasetContext::content

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

isFinalBlock

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block bool ndn::mgmt::StatusDatasetContext::isFinalBlock

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

---

The documentation for this class was generated from the following files:

• ndnSIM/ndn-cxx/ndn-cxx/mgmt/status-dataset-context.hpp
• ndnSIM/ndn-cxx/ndn-cxx/mgmt/status-dataset-context.cpp