NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::mgmt::StatusDatasetContext Class Reference

provides a context for generating 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

typedef std::function< void(const ControlResponse &resp)> NackSender
 

Public Member Functions

const NamegetPrefix () const
 
StatusDatasetContextsetPrefix (const Name &prefix)
 change prefix of Data packets More...
 
const time::milliseconds & getExpiry () const
 
StatusDatasetContextsetExpiry (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, const NackSender &nackSender)
 

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 Blockcontent
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block time::milliseconds imsFresh
 
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block time::milliseconds bool isFinalBlock DataSender
 

Friends

class Dispatcher
 

Detailed Description

provides a context for generating response to a StatusDataset request

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

Member Typedef Documentation

◆ NackSender

typedef std::function<void(const ControlResponse& resp)> ndn::mgmt::StatusDatasetContext::NackSender

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

Constructor & Destructor Documentation

◆ StatusDatasetContext()

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

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

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

Member Function Documentation

◆ getPrefix()

const Name & ndn::mgmt::StatusDatasetContext::getPrefix ( ) const
Returns
prefix of Data packets, with version component but without segment component

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

◆ setPrefix()

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

change prefix of Data packets

Parameters
prefixthe prefix; it must start with Interest Name, may contain version component, but must not contain segment component
Exceptions
std::invalid_argumentprefix does not start with Interest Name
std::domain_errorappend, 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 36 of file status-dataset-context.cpp.

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

Referenced by StatusDatasetContext().

◆ getExpiry()

const time::milliseconds & ndn::mgmt::StatusDatasetContext::getExpiry ( ) const
Returns
expiration duration for this dataset response

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

◆ setExpiry()

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 62 of file status-dataset-context.cpp.

◆ append()

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

append a Block to the response

Exceptions
std::domain_errorend or reject has been invoked

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

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

◆ end()

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

end the response successfully after appending zero or more blocks

Exceptions
std::domain_errorreject has been invoked

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

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

◆ reject()

void ndn::mgmt::StatusDatasetContext::reject ( const ControlResponse resp = ControlResponse().setCode(400))

declare the non-existence of a response

Exceptions
std::domain_errorappend or end has been invoked

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

Parameters
respContent of producer-generated NACK

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

References NDN_THROW.

Friends And Related Function Documentation

◆ Dispatcher

friend class Dispatcher
friend

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

Member Data Documentation

◆ __pad0__

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE ndn::mgmt::StatusDatasetContext::__pad0__

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

◆ content

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

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

◆ imsFresh

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block time::milliseconds ndn::mgmt::StatusDatasetContext::imsFresh

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

◆ DataSender

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE const Block time::milliseconds bool isFinalBlock ndn::mgmt::StatusDatasetContext::DataSender

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


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