Represents a Data packet. More...

#include <data.hpp>

Inheritance diagram for ndn::Data:

[legend]

Collaboration diagram for ndn::Data:

Classes
class	Error

Public Member Functions
	Data (const Name &name=Name())
	Construct an unsigned Data packet with given `name` and empty Content. More...

	Data (const Block &wire)
	Construct a Data packet by decoding from `wire`. More...

template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &encoder, bool wantUnsignedPortionOnly=false) const
	Prepend wire encoding to `encoder` in NDN Packet Format v0.2. More...

const Block &	wireEncode (EncodingBuffer &encoder, const Block &signatureValue) const
	Finalize Data packet encoding with the specified SignatureValue. More...

const Block &	wireEncode () const
	Encode to a `Block`. More...

void	wireDecode (const Block &wire)
	Decode from `wire` in NDN Packet Format v0.2 or v0.3. More...

bool	hasWire () const
	Check if this instance has cached wire encoding. More...

const Name &	getFullName () const
	Get full name including implicit digest. More...

const Name &	getName () const
	Get name. More...

Data &	setName (const Name &name)
	Set name. More...

const MetaInfo &	getMetaInfo () const
	Get MetaInfo. More...

Data &	setMetaInfo (const MetaInfo &metaInfo)
	Set MetaInfo. More...

const Block &	getContent () const
	Get Content. More...

Data &	setContent (const Block &block)
	Set Content from a block. More...

Data &	setContent (const uint8_t *value, size_t valueSize)
	Copy Content value from raw buffer. More...

Data &	setContent (const ConstBufferPtr &value)
	Set Content from wire buffer. More...

const Signature &	getSignature () const
	Get Signature. More...

Data &	setSignature (const Signature &signature)
	Set Signature. More...

Data &	setSignatureValue (const Block &value)
	Set SignatureValue. More...

uint32_t	getContentType () const

Data &	setContentType (uint32_t type)

time::milliseconds	getFreshnessPeriod () const

Data &	setFreshnessPeriod (time::milliseconds freshnessPeriod)

const optional< name::Component > &	getFinalBlock () const

Data &	setFinalBlock (optional< name::Component > finalBlockId)

NDN_CXX_DEPRECATED name::Component	getFinalBlockId () const

NDN_CXX_DEPRECATED Data &	setFinalBlockId (const name::Component &finalBlockId)

Public Member Functions inherited from ndn::PacketBase
uint64_t	getCongestionMark () const
	get the value of the CongestionMark tag More...

void	setCongestionMark (uint64_t mark)
	set the CongestionMark tag to the specified value More...

Public Member Functions inherited from ndn::TagHost
template<typename T >
shared_ptr< T >	getTag () const
	get a tag item More...

template<typename T >
void	setTag (shared_ptr< T > tag) const
	set a tag item More...

template<typename T >
void	removeTag () const
	remove tag item More...

Protected Member Functions
void	resetWire ()
	Clear wire encoding and cached FullName. More...

Detailed Description

Represents a Data packet.

Definition at line 35 of file data.hpp.

Constructor & Destructor Documentation

◆ Data() [1/2]

ndn::Data::Data ( const Name & name = Name() )

explicit

Construct an unsigned Data packet with given name and empty Content.

Warning: In certain contexts that use Data::shared_from_this(), Data must be created using make_shared. Otherwise, shared_from_this() will trigger undefined behavior.

Definition at line 35 of file data.cpp.

◆ Data() [2/2]

ndn::Data::Data ( const Block & wire )

explicit

Construct a Data packet by decoding from wire.

Parameters

wire	`tlv::Data` element as defined in NDN Packet Format v0.2 or v0.3. It may be signed or unsigned.

Warning: In certain contexts that use Data::shared_from_this(), Data must be created using make_shared. Otherwise, shared_from_this() will trigger undefined behavior.

Definition at line 41 of file data.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode() [1/3]

template<encoding::Tag TAG>

size_t ndn::Data::wireEncode	(	EncodingImpl< TAG > &	encoder,
		bool	wantUnsignedPortionOnly = `false`
	)		const

Prepend wire encoding to encoder in NDN Packet Format v0.2.

Parameters

encoder	EncodingEstimator or EncodingBuffer instance
wantUnsignedPortionOnly	If true, only prepends Name, MetaInfo, Content, and SignatureInfo to `encoder`, but omit SignatureValue and outmost Type-Length of Data element. This is intended to be used with wireEncode(encoder, signatureValue).

Exceptions

Error SignatureBits are not provided and wantUnsignedPortionOnly is false.

Definition at line 48 of file data.cpp.

References ndn::tlv::Data, getContent(), ndn::Signature::getInfo(), getMetaInfo(), getName(), ndn::Signature::getValue(), ndn::MetaInfo::wireEncode(), and ndn::Name::wireEncode().

Referenced by ndn::security::pib::PibSqlite3::addCertificate(), ndn::security::pib::detail::KeyImpl::getDefaultCertificate(), ndn::security::parse(), ndn::util::DummyClientFace::receive(), ndn::security::v2::KeyChain::sign(), and ndn::security::SafeBag::wireEncode().

◆ wireEncode() [2/3]

const Block & ndn::Data::wireEncode	(	EncodingBuffer &	encoder,
		const Block &	signatureValue
	)		const

Finalize Data packet encoding with the specified SignatureValue.

Parameters

encoder	EncodingBuffer containing Name, MetaInfo, Content, and SignatureInfo, but without SignatureValue or outmost Type-Length of Data element
signatureValue	SignatureValue element

This method is intended to be used in concert with Data::wireEncode(encoder, true)

Data data;
...
EncodingBuffer encoder;
data.wireEncode(encoder, true);
...
Block signatureValue = <sign_over_unsigned_portion>(encoder.buf(), encoder.size());
data.wireEncode(encoder, signatureValue)

Definition at line 93 of file data.cpp.

References ndn::tlv::Data, ndn::Block::size(), and wireDecode().

◆ wireEncode() [3/3]

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

Encode to a Block.

Precondition: Data is signed.

Normally, this function encodes to NDN Packet Format v0.2. However, if this instance has cached wire encoding (hasWire() is true), the cached encoding is returned and it might be in v0.3 format.

Definition at line 106 of file data.cpp.

References ndn::Block::hasWire(), and wireDecode().

◆ wireDecode()

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

Decode from wire in NDN Packet Format v0.2 or v0.3.

Definition at line 122 of file data.cpp.

References ndn::Name::clear(), ndn::tlv::Content, ndn::Block::elements(), ndn::tlv::isCriticalType(), ndn::tlv::MetaInfo, ndn::tlv::Name, ndn::Block::parse(), ndn::Signature::setInfo(), ndn::Signature::setValue(), ndn::tlv::SignatureInfo, ndn::tlv::SignatureValue, ndn::to_string(), ndn::MetaInfo::wireDecode(), and ndn::Name::wireDecode().

Referenced by Data(), ndn::Link::wireDecode(), ndn::security::SafeBag::wireDecode(), and wireEncode().

◆ hasWire()

bool ndn::Data::hasWire ( ) const

inline

Check if this instance has cached wire encoding.

Definition at line 112 of file data.hpp.

References ndn::Block::hasWire().

◆ getFullName()

const Name & ndn::Data::getFullName ( ) const

Get full name including implicit digest.

Precondition: hasWire() == true; i.e. wireEncode() must have been called

Exceptions

Error Data has no wire encoding

Definition at line 197 of file data.cpp.

References ndn::Name::appendImplicitSha256Digest(), ndn::util::Sha256::computeDigest(), ndn::Name::empty(), ndn::Block::hasWire(), ndn::Block::size(), and ndn::Block::wire().

Referenced by nfd::cs::compareDataWithData(), nfd::cs::compareQueryWithData(), ndn::InMemoryStorage::insert(), and ndn::Interest::matchesData().

◆ getName()

const Name& ndn::Data::getName ( ) const

inline

Get name.

Definition at line 128 of file data.hpp.

◆ setName()

Data & ndn::Data::setName ( const Name & name )

Set name.

Returns: a reference to this Data, to allow chaining

Definition at line 218 of file data.cpp.

References resetWire().

◆ getMetaInfo()

const MetaInfo& ndn::Data::getMetaInfo ( ) const

inline

Get MetaInfo.

Definition at line 142 of file data.hpp.

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

◆ setMetaInfo()

Data & ndn::Data::setMetaInfo ( const MetaInfo & metaInfo )

Set MetaInfo.

Returns: a reference to this Data, to allow chaining

Definition at line 226 of file data.cpp.

References resetWire().

◆ getContent()

const Block & ndn::Data::getContent ( ) const

Get Content.

The Content value is accessible through value()/value_size() or value_begin()/value_end() methods of the Block class.

Definition at line 234 of file data.cpp.

References ndn::Block::hasWire().

Referenced by ndn::security::pib::PibMemory::addCertificate(), ndn::security::pib::PibSqlite3::addCertificate(), ndn::security::v2::KeyChain::addCertificate(), ndn::security::v2::Certificate::Certificate(), ndn::security::v2::Certificate::getPublicKey(), ndn::operator<<(), ndn::operator==(), ndn::security::verifySignature(), ndn::Link::wireDecode(), and wireEncode().

◆ setContent() [1/3]

Data & ndn::Data::setContent ( const Block & block )

Set Content from a block.

If block's TLV-TYPE is Content, it will be used directly as Data's Content element. If block's TLV-TYPE is not Content, it will be nested into a Content element.