#include <status-dataset-context.hpp>

Collaboration diagram for ndn::mgmt::StatusDatasetContext:

Public Member Functions
const Name &	getPrefix () const

StatusDatasetContext &	setPrefix (const Name &prefix)
	change prefix of Data packets More...

const time::milliseconds &	getExpiry () const

StatusDatasetContext &	setExpiry (const time::milliseconds &expiry)
	set expiration duration More...

void	append (const Block &block)
	append a Block to the response More...

void	end ()
	end the response successfully after appending zero or more blocks More...

void	reject (const ControlResponse &resp=ControlResponse().setCode(400))
	declare the non-existence of a response More...

	StatusDatasetContext (const Interest &interest, const DataSender &dataSender)

Public Attributes
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: typedef 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 const MetaInfo &metaInfo	DataSender

Friends
class	Dispatcher

Detailed Description

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

Constructor & Destructor Documentation

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

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

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

Member Function Documentation

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

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

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

StatusDatasetContext & ndn::mgmt::StatusDatasetContext::setPrefix ( const Name & prefix )

change prefix of Data packets

Parameters

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

Exceptions

std::invalid_argument	prefix does not start with Interest Name
std::domain_error	append, end, or reject has been invoked

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 current timestamp when omitted.

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

References ndn::Name::appendVersion(), ndn::Interest::getName(), and ndn::Name::isPrefixOf().

Referenced by StatusDatasetContext().

const time::milliseconds & ndn::mgmt::StatusDatasetContext::getExpiry ( ) const

Returns: expiration duration for this dataset response

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

StatusDatasetContext & ndn::mgmt::StatusDatasetContext::setExpiry ( const time::milliseconds & expiry )

set expiration duration

The response will be cached for the specified duration. Incoming Interest that matches a cached response will be satisfied with that response, without invoking StatusDatasetHandler again.

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

void ndn::mgmt::StatusDatasetContext::append ( const Block & block )

append a Block to the response

Exceptions

std::domain_error end or reject has been invoked

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

References ndn::tlv::Content, content, ndn::encoding::makeBinaryBlock(), ndn::MAX_NDN_PACKET_SIZE, ndn::tlv::MetaInfo, ns3::ndn::Name, ndn::Block::size(), and ndn::Block::wire().

void ndn::mgmt::StatusDatasetContext::end ( )

end the response successfully after appending zero or more blocks

Exceptions

std::domain_error reject has been invoked

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