An MetaInfo holds the meta info which is signed inside the data packet. More...

#include <meta-info.hpp>

Classes
class	Error

Public Member Functions
	MetaInfo ()

	MetaInfo (const Block &block)
	Create from wire encoding. More...

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder) const

const Block &	wireEncode () const

void	wireDecode (const Block &wire)

uint32_t	getType () const

MetaInfo &	setType (uint32_t type)
	set ContentType More...

const time::milliseconds &	getFreshnessPeriod () const

MetaInfo &	setFreshnessPeriod (time::milliseconds freshnessPeriod)
	set FreshnessPeriod More...

const name::Component &	getFinalBlockId () const

MetaInfo &	setFinalBlockId (const name::Component &finalBlockId)

const std::list< Block > &	getAppMetaInfo () const
	Get all app-defined MetaInfo items. More...

MetaInfo &	setAppMetaInfo (const std::list< Block > &info)
	Set app-defined MetaInfo items. More...

MetaInfo &	addAppMetaInfo (const Block &block)
	Add an app-defined MetaInfo item. More...

bool	removeAppMetaInfo (uint32_t tlvType)
	Remove a first app-defined MetaInfo item with type `tlvType`. More...

const Block *	findAppMetaInfo (uint32_t tlvType) const
	Find a first app-defined MetaInfo item of type `tlvType`. More...

bool	operator== (const MetaInfo &other) const

bool	operator!= (const MetaInfo &other) const

Detailed Description

An MetaInfo holds the meta info which is signed inside the data packet.

The class allows experimentation with application-defined meta information blocks, which slightly violates NDN-TLV specification. When using the application-defined meta information blocks be aware that this may result in packet drop (NFD and previous versions of ndn-cxx will gracefully accept such packet).

The following definition of MetaInfo block is assumed in this implementation (compared to the NDN-TLV spec, definition extended to allow optional AppMetaInfo TLV blocks):

MetaInfo ::= META-INFO-TYPE TLV-LENGTH
               ContentType?
               FreshnessPeriod?
               FinalBlockId?
               AppMetaInfo*

AppMetaInfo ::= any TLV block with type in the restricted application range [128, 252]

Note that AppMetaInfo blocks are application-defined and must have TLV type from the restricted application range [128, 252].

Definition at line 58 of file meta-info.hpp.

Constructor & Destructor Documentation

ndn::MetaInfo::MetaInfo ( )

Definition at line 35 of file meta-info.cpp.

Referenced by ndn::MetaInfo::Error::Error().

ndn::MetaInfo::MetaInfo ( const Block & block )

explicit

Create from wire encoding.

Definition at line 41 of file meta-info.cpp.

References wireDecode().

Member Function Documentation

template<encoding::Tag TAG>

size_t ndn::MetaInfo::wireEncode ( EncodingImpl< TAG > & encoder ) const

Definition at line 133 of file meta-info.cpp.

References ndn::tlv::ContentType, ndn::tlv::ContentType_Blob, ndn::DEFAULT_FRESHNESS_PERIOD, ndn::name::Component::empty(), ndn::tlv::FinalBlockId, ndn::tlv::FreshnessPeriod, ndn::tlv::MetaInfo, ndn::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), ndn::encoding::prependNestedBlock(), and ndn::encoding::prependNonNegativeIntegerBlock().

Referenced by operator==(), and ndn::Data::wireEncode().

const Block & ndn::MetaInfo::wireEncode ( ) const

Definition at line 171 of file meta-info.cpp.

References ndn::Block::hasWire().

Referenced by ndn::MetaInfo::Error::Error(), and operator==().

void ndn::MetaInfo::wireDecode ( const Block & wire )

Definition at line 187 of file meta-info.cpp.

References ndn::Block::blockFromValue(), ndn::tlv::ContentType, ndn::tlv::ContentType_Blob, ndn::DEFAULT_FRESHNESS_PERIOD, ndn::Block::elements(), ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::FinalBlockId, ndn::tlv::FreshnessPeriod, websocketpp::lib::asio::milliseconds(), ndn::tlv::NameComponent, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), and ndn::Block::type().

Referenced by ndn::MetaInfo::Error::Error(), MetaInfo(), and ndn::Data::wireDecode().

uint32_t ndn::MetaInfo::getType ( ) const

inline

Definition at line 207 of file meta-info.hpp.

References websocketpp::lib::asio::milliseconds().

Referenced by ndn::MetaInfo::Error::Error(), and ndn::operator<<().

MetaInfo & ndn::MetaInfo::setType ( uint32_t type )

set ContentType

Parameters

type	a code defined in tlv::ContentTypeValue

Definition at line 47 of file meta-info.cpp.

References ndn::Block::reset().

Referenced by ndn::MetaInfo::Error::Error(), ndn::mgmt::Dispatcher::removeTopPrefix(), and ndn::Data::setContentType().

const time::milliseconds & ndn::MetaInfo::getFreshnessPeriod ( ) const

inline

Definition at line 213 of file meta-info.hpp.

Referenced by ndn::MetaInfo::Error::Error(), and ndn::operator<<().

MetaInfo & ndn::MetaInfo::setFreshnessPeriod ( time::milliseconds freshnessPeriod )

set FreshnessPeriod

Exceptions

std::invalid_argument specified FreshnessPeriod is < 0

Definition at line 55 of file meta-info.cpp.

References ndn::Block::reset().

Referenced by ndn::MetaInfo::Error::Error(), and ndn::Data::setFreshnessPeriod().

const name::Component & ndn::MetaInfo::getFinalBlockId ( ) const

inline

Definition at line 219 of file meta-info.hpp.

Referenced by ndn::security::v2::CertificateBundleFetcher::doFetch(), ndn::MetaInfo::Error::Error(), ndn::util::SegmentFetcher::fetch(), and ndn::operator<<().

MetaInfo & ndn::MetaInfo::setFinalBlockId ( const name::Component & finalBlockId )

Definition at line 66 of file meta-info.cpp.

References ndn::Block::reset().

Referenced by ndn::mgmt::Dispatcher::addStatusDataset(), ndn::MetaInfo::Error::Error(), and ndn::Data::setFinalBlockId().

const std::list< Block > & ndn::MetaInfo::getAppMetaInfo ( ) const

Get all app-defined MetaInfo items.

Note: Warning: Experimental API, which may change or disappear in the future; If MetaInfo is decoded from wire and setType, setFreshnessPeriod, or setFinalBlockId is called before *AppMetaInfo, all app-defined blocks will be lost

Definition at line 74 of file meta-info.cpp.

Referenced by ndn::MetaInfo::Error::Error(), and ndn::operator<<().

MetaInfo & ndn::MetaInfo::setAppMetaInfo ( const std::list< Block > & info )

Set app-defined MetaInfo items.

This method will replace all existing app-defined MetaInfo items, if they existed.

Exceptions

Error if some block in info has type not in the application range (http://named-data.net/doc/ndn-tlv/types.html)

Note: Warning: Experimental API, which may change or disappear in the future; If MetaInfo is decoded from wire and setType, setFreshnessPeriod, or setFinalBlockId is called before *AppMetaInfo, all app-defined blocks will be lost

Definition at line 80 of file meta-info.cpp.

References ndn::Block::reset().

Referenced by ndn::MetaInfo::Error::Error().

MetaInfo & ndn::MetaInfo::addAppMetaInfo ( const Block & block )

Add an app-defined MetaInfo item.

Exceptions

Error if block has type not in the application range (http://named-data.net/doc/ndn-tlv/types.html)

Note: Warning: Experimental API, which may change or disappear in the future; If MetaInfo is decoded from wire and setType, setFreshnessPeriod, or setFinalBlockId is called before *AppMetaInfo, all app-defined blocks will be lost

Definition at line 94 of file meta-info.cpp.

References ndn::Block::reset(), and ndn::Block::type().

Referenced by ndn::MetaInfo::Error::Error().

bool ndn::MetaInfo::removeAppMetaInfo ( uint32_t tlvType )

Remove a first app-defined MetaInfo item with type tlvType.

Returns: true if an item was deleted

Note: Warning: Experimental API, which may change or disappear in the future; If MetaInfo is decoded from wire and setType, setFreshnessPeriod, or setFinalBlockId is called before *AppMetaInfo, all app-defined blocks will be lost

Definition at line 106 of file meta-info.cpp.

References ndn::Block::reset(), and tlvType.

Referenced by ndn::MetaInfo::Error::Error().

const Block * ndn::MetaInfo::findAppMetaInfo ( uint32_t tlvType ) const

Find a first app-defined MetaInfo item of type tlvType.

Returns: NULL if an item is not found, otherwise const pointer to the item

Exceptions

Error if tlvType is not in the application range (http://named-data.net/doc/ndn-tlv/types.html)

Note: Warning: Experimental API, which may change or disappear in the future; If MetaInfo is decoded from wire and setType, setFreshnessPeriod, or setFinalBlockId is called before *AppMetaInfo, all app-defined blocks will be lost

Definition at line 120 of file meta-info.cpp.

References tlvType.

Referenced by ndn::MetaInfo::Error::Error().

bool ndn::MetaInfo::operator== ( const MetaInfo & other ) const

inline

Definition at line 225 of file meta-info.hpp.

References wireEncode().

Referenced by ndn::MetaInfo::Error::Error().

bool ndn::MetaInfo::operator!= ( const MetaInfo & other ) const

inline

Definition at line 231 of file meta-info.hpp.

Referenced by ndn::MetaInfo::Error::Error().

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

ndnSIM/ndn-cxx/src/meta-info.hpp
ndnSIM/ndn-cxx/src/meta-info.cpp

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation