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 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...

Friends
class	Dispatcher
	Copyright (c) 2013-2017 Regents of the University of California. More...

Detailed Description

provides a context for generating response to a StatusDataset request

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

Member Function Documentation

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

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

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.

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.

void ndn::mgmt::StatusDatasetContext::reject

(

const ControlResponse &

resp = ControlResponse().setCode(400)

)

declare the non-existence of a response

Exceptions

std::domain_error

append 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

resp	Content of producer-generated NACK

Definition at line 109 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 62 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 36 of file status-dataset-context.cpp.

Friends And Related Function Documentation

friend class Dispatcher

friend

Copyright (c) 2013-2017 Regents of the University of California.

This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).

ndn-cxx library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received copies of the GNU General Public License and GNU Lesser General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see http://www.gnu.org/licenses/.

See AUTHORS.md for complete list of ndn-cxx authors and contributors.

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