ndn::MetaInfo Class Reference

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

#include <meta-info.hpp>

Public Member Functions
void	get (struct ndn_MetaInfo &metaInfoStruct) const
	Set the metaInfoStruct to point to the values in this meta info object, without copying any memory. More...
void	set (const struct ndn_MetaInfo &metaInfoStruct)
	Clear this meta info, and set the values by copying from the ndn_MetaInfo struct. More...
MillisecondsSince1970 DEPRECATED_IN_NDN_CPP	getTimestampMilliseconds () const
ndn_ContentType	getType () const
Milliseconds	getFreshnessPeriod () const
int DEPRECATED_IN_NDN_CPP	getFreshnessSeconds () const
const Name::Component &	getFinalBlockId () const
	Get the final block ID. More...
const Name::Component &DEPRECATED_IN_NDN_CPP	getFinalBlockID () const
void DEPRECATED_IN_NDN_CPP	setTimestampMilliseconds (MillisecondsSince1970 timestampMilliseconds)
void	setType (ndn_ContentType type)
void	setFreshnessPeriod (Milliseconds freshnessPeriod)
void DEPRECATED_IN_NDN_CPP	setFreshnessSeconds (int freshnessSeconds)
void	setFinalBlockId (const Name::Component &finalBlockId)
	Set the final block ID. More...
void DEPRECATED_IN_NDN_CPP	setFinalBlockID (const Name::Component &finalBlockId)
uint64_t	getChangeCount () const
	Get the change count, which is incremented each time this object is changed. More...

Detailed Description

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

Member Function Documentation

void ndn::MetaInfo::get

(

struct ndn_MetaInfo & metaInfoStruct

)

const

Set the metaInfoStruct to point to the values in this meta info object, without copying any memory.

WARNING: The resulting pointers in metaInfoStruct are invalid after a further use of this object which could reallocate memory.

Parameters

metaInfoStruct

a C ndn_MetaInfo struct where the name components array is already allocated.

uint64_t ndn::MetaInfo::getChangeCount ( ) const

inline

Get the change count, which is incremented each time this object is changed.

Returns

The change count.

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

inline

Get the final block ID.

Returns

The final block ID as a Name::Component. If the name component getValue().size() is 0, then the final block ID is not specified.

const Name::Component& DEPRECATED_IN_NDN_CPP ndn::MetaInfo::getFinalBlockID ( ) const

inline

Deprecated:

Use getFinalBlockId.

int DEPRECATED_IN_NDN_CPP ndn::MetaInfo::getFreshnessSeconds ( ) const

inline

Deprecated:

Use getFreshnessPeriod.

MillisecondsSince1970 DEPRECATED_IN_NDN_CPP ndn::MetaInfo::getTimestampMilliseconds ( ) const

inline

Deprecated:

Use the application-specific content to store a timestamp.

void ndn::MetaInfo::set

(

const struct ndn_MetaInfo & metaInfoStruct

)

Clear this meta info, and set the values by copying from the ndn_MetaInfo struct.

Parameters

metaInfoStruct

a C ndn_MetaInfo struct

void ndn::MetaInfo::setFinalBlockId ( const Name::Component &  finalBlockId )

inline

Set the final block ID.

Parameters

finalBlockId

The final block ID as a Name::Component. If the name component getValue().size() is 0, then the final block ID is not specified.

void DEPRECATED_IN_NDN_CPP ndn::MetaInfo::setFinalBlockID ( const Name::Component &  finalBlockId )

inline

Deprecated:

Use setFinalBlockId.

void DEPRECATED_IN_NDN_CPP ndn::MetaInfo::setFreshnessSeconds ( int  freshnessSeconds )

inline

Deprecated:

Use setFreshnessPeriod.

void DEPRECATED_IN_NDN_CPP ndn::MetaInfo::setTimestampMilliseconds ( MillisecondsSince1970  timestampMilliseconds )

inline

Deprecated:

Use the application-specific content to store a timestamp.

---

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

• include/ndn-cpp/meta-info.hpp
• src/meta-info.cpp