ndn::Block Class Reference

Represents a TLV element of NDN packet format. More...

#include <block.hpp>

Inheritance diagram for ndn::Block:

Collaboration diagram for ndn::Block:

Classes
class	Error

Public Types
using	element_container = std::vector< Block >
using	element_iterator = element_container::iterator
using	element_const_iterator = element_container::const_iterator

Public Member Functions
	Block ()
	Create an invalid Block. More...
	Block (const Block &)
	Copy constructor. More...
Block &	operator= (const Block &)
	Copy assignment operator. More...
	Block (Block &&) noexcept
	Move constructor. More...
Block &	operator= (Block &&) noexcept
	Move assignment operator. More...
	Block (const EncodingBuffer &buffer)
	Parse Block from an EncodingBuffer. More...
	Block (const ConstBufferPtr &buffer)
	Parse Block from a wire Buffer. More...
	Block (ConstBufferPtr buffer, Buffer::const_iterator begin, Buffer::const_iterator end, bool verifyLength=true)
	Parse Block within boundaries of a wire Buffer. More...
	Block (const Block &block, Buffer::const_iterator begin, Buffer::const_iterator end, bool verifyLength=true)
	Parse Block within boundaries of an existing Block, reusing underlying wire Buffer. More...
	Block (ConstBufferPtr buffer, uint32_t type, Buffer::const_iterator begin, Buffer::const_iterator end, Buffer::const_iterator valueBegin, Buffer::const_iterator valueEnd)
	Create a Block from a wire Buffer without parsing. More...
	Block (const uint8_t *buf, size_t bufSize)
	Parse Block from a raw buffer. More...
	Block (uint32_t type)
	Create a zero-length Block with the specified TLV-TYPE. More...
	Block (uint32_t type, ConstBufferPtr value)
	Create a Block with the specified TLV-TYPE and TLV-VALUE. More...
	Block (uint32_t type, const Block &value)
	Create a Block with the specified TLV-TYPE and TLV-VALUE. More...
bool	isValid () const noexcept
	Check if the Block is valid. More...
NDN_CXX_NODISCARD bool	empty () const noexcept
	Check if the Block is empty. More...
void	reset () noexcept
	Reset the Block to a default-constructed state. More...
void	resetWire () noexcept
	Reset wire buffer but keep TLV-TYPE and sub-elements (if any) More...
bool	hasWire () const noexcept
	Check if the Block contains a fully encoded wire representation. More...
Buffer::const_iterator	begin () const
	Get begin iterator of encoded wire. More...
Buffer::const_iterator	end () const
	Get end iterator of encoded wire. More...
const uint8_t *	wire () const
	Return a raw pointer to the beginning of the encoded wire. More...
size_t	size () const
	Return the size of the encoded wire, i.e. More...
ConstBufferPtr	getBuffer () const
	Get underlying buffer. More...
uint32_t	type () const
	Return the TLV-TYPE of the Block. More...
bool	hasValue () const noexcept
	Check if the Block has a non-empty TLV-VALUE. More...
Buffer::const_iterator	value_begin () const
	Get begin iterator of TLV-VALUE. More...
Buffer::const_iterator	value_end () const
	Get end iterator of TLV-VALUE. More...
const uint8_t *	value () const noexcept
	Return a raw pointer to the beginning of TLV-VALUE. More...
size_t	value_size () const noexcept
	Return the size of TLV-VALUE, aka TLV-LENGTH. More...
Block	blockFromValue () const
void	parse () const
	Parse TLV-VALUE into sub-elements. More...
void	encode ()
	Encode sub-elements into TLV-VALUE. More...
const Block &	get (uint32_t type) const
	Return the first sub-element of the specified TLV-TYPE. More...
element_const_iterator	find (uint32_t type) const
	Find the first sub-element of the specified TLV-TYPE. More...
void	remove (uint32_t type)
	Remove all sub-elements of the specified TLV-TYPE. More...
element_iterator	erase (element_const_iterator position)
	Erase a sub-element. More...
element_iterator	erase (element_const_iterator first, element_const_iterator last)
	Erase a range of sub-elements. More...
void	push_back (const Block &element)
	Append a sub-element. More...
element_iterator	insert (element_const_iterator pos, const Block &element)
	Insert a sub-element. More...
const element_container &	elements () const
	Get container of sub-elements. More...
element_const_iterator	elements_begin () const
	Equivalent to elements().begin() More...
element_const_iterator	elements_end () const
	Equivalent to elements().end() More...
size_t	elements_size () const
	Equivalent to elements().size() More...
	operator boost::asio::const_buffer () const
	Implicit conversion to boost::asio::const_buffer More...

Static Public Member Functions
static Block	fromStream (std::istream &is)
	Parse Block from an input stream. More...
static NDN_CXX_NODISCARD std::tuple< bool, Block >	fromBuffer (ConstBufferPtr buffer, size_t offset)
	Try to parse Block from a wire buffer. More...
static NDN_CXX_NODISCARD std::tuple< bool, Block >	fromBuffer (const uint8_t *buf, size_t bufSize)
	Try to parse Block from a raw buffer. More...

Protected Attributes
shared_ptr< const Buffer >	m_buffer
	Underlying buffer storing TLV-VALUE and possibly TLV-TYPE and TLV-LENGTH fields. More...
Buffer::const_iterator	m_begin
Buffer::const_iterator	m_end
Buffer::const_iterator	m_valueBegin
Buffer::const_iterator	m_valueEnd
uint32_t	m_type = tlv::Invalid
	TLV-TYPE. More...
size_t	m_size = 0
	Total size including Type-Length-Value. More...
element_container	m_elements
	Contains the sub-elements. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Block &block)
	Print block to os. More...

Detailed Description

Represents a TLV element of NDN packet format.

See also

https://named-data.net/doc/NDN-packet-spec/current/

Definition at line 42 of file block.hpp.

Member Typedef Documentation

element_container

using ndn::Block::element_container = std::vector<Block>

Definition at line 45 of file block.hpp.

element_iterator

using ndn::Block::element_iterator = element_container::iterator

Definition at line 46 of file block.hpp.

element_const_iterator

using ndn::Block::element_const_iterator = element_container::const_iterator

Definition at line 47 of file block.hpp.

Constructor & Destructor Documentation

Block() [1/12]

ndn::Block::Block ( )

default

Create an invalid Block.

Postcondition

isValid() == false

Referenced by blockFromValue(), fromBuffer(), and fromStream().

Block() [2/12]

ndn::Block::Block ( const Block &  )

default

Copy constructor.

Block() [3/12]

ndn::Block::Block ( Block &&  )

inlinedefaultnoexcept

Move constructor.

Block() [4/12]

ndn::Block::Block ( const EncodingBuffer &  buffer )

explicit

Parse Block from an EncodingBuffer.

Parameters

buffer

an EncodingBuffer containing one TLV element

Exceptions

tlv::Error

Type-Length parsing fails, or TLV-LENGTH does not match size of TLV-VALUE

Definition at line 51 of file block.cpp.

Block() [5/12]

ndn::Block::Block ( const ConstBufferPtr &  buffer )

explicit

Parse Block from a wire Buffer.

Parameters

buffer

a Buffer containing one TLV element

Note

This constructor takes shared ownership of buffer.

Exceptions

tlv::Error

Type-Length parsing fails, or TLV-LENGTH does not match size of TLV-VALUE

Definition at line 56 of file block.cpp.

Block() [6/12]

ndn::Block::Block	(	ConstBufferPtr	buffer,
		Buffer::const_iterator	begin,
		Buffer::const_iterator	end,
		bool	verifyLength = true
	)

Parse Block within boundaries of a wire Buffer.

Parameters

buffer	a Buffer containing a TLV element at [begin,end)
begin	begin position of the TLV element within buffer
end	end position of the TLV element within buffer
verifyLength	if true, check TLV-LENGTH equals size of TLV-VALUE

Exceptions

std::invalid_argument	buffer is empty, or [begin,end) range is not within buffer
tlv::Error	Type-Length parsing fails, or TLV-LENGTH does not match size of TLV-VALUE

Note

This overload automatically detects TLV-TYPE and position of TLV-VALUE.

Block() [7/12]

ndn::Block::Block	(	const Block &	block,
		Buffer::const_iterator	begin,
		Buffer::const_iterator	end,
		bool	verifyLength = true
	)

Parse Block within boundaries of an existing Block, reusing underlying wire Buffer.

Parameters

block	a Block whose buffer contains a TLV element at [begin,end)
begin	begin position of the TLV element within block
end	end position of the TLV element within block
verifyLength	if true, check TLV-LENGTH equals size of TLV-VALUE

Exceptions

std::invalid_argument	[begin,end) range is not within block
tlv::Error	Type-Length parsing fails, or TLV-LENGTH does not match size of TLV-VALUE

Block() [8/12]

ndn::Block::Block	(	ConstBufferPtr	buffer,
		uint32_t	type,
		Buffer::const_iterator	begin,
		Buffer::const_iterator	end,
		Buffer::const_iterator	valueBegin,
		Buffer::const_iterator	valueEnd
	)

Create a Block from a wire Buffer without parsing.

Parameters

buffer	a Buffer containing a TLV element at [begin,end)
type	TLV-TYPE
begin	begin position of the TLV element within buffer
end	end position of the TLV element within buffer
valueBegin	begin position of TLV-VALUE within buffer
valueEnd	end position of TLV-VALUE within buffer

Definition at line 96 of file block.cpp.

Block() [9/12]

ndn::Block::Block	(	const uint8_t *	buf,
		size_t	bufSize
	)

Parse Block from a raw buffer.

Parameters

buf	pointer to the first octet of a TLV element
bufSize	size of the raw buffer; may be greater than the actual size of the TLV element

Exceptions

tlv::Error

Type-Length parsing fails, or size of TLV-VALUE exceeds bufSize

Note

This overload copies the TLV element octets into an internal wire buffer.

Definition at line 109 of file block.cpp.

References buf, end(), m_begin, m_buffer, m_end, m_size, m_type, m_valueBegin, m_valueEnd, NDN_THROW, ndn::tlv::readType(), and ndn::tlv::readVarNumber().

Block() [10/12]

ndn::Block::Block ( uint32_t  type )

explicit

Create a zero-length Block with the specified TLV-TYPE.

Parameters

type

TLV-TYPE

Definition at line 133 of file block.cpp.

Block() [11/12]

ndn::Block::Block	(	uint32_t	type,
		ConstBufferPtr	value
	)

Create a Block with the specified TLV-TYPE and TLV-VALUE.

Parameters

type	TLV-TYPE
value	a Buffer containing the TLV-VALUE, must not be nullptr

Definition at line 139 of file block.cpp.

References m_size, m_type, ndn::tlv::sizeOfVarNumber(), and value_size().

Block() [12/12]

ndn::Block::Block	(	uint32_t	type,
		const Block &	value
	)

Create a Block with the specified TLV-TYPE and TLV-VALUE.

Parameters

type	TLV-TYPE
value	a Block to be nested as TLV-VALUE, must be valid

Definition at line 150 of file block.cpp.

References m_size, m_type, ndn::tlv::sizeOfVarNumber(), and value_size().

Member Function Documentation

operator=() [1/2]

Block & ndn::Block::operator= ( const Block &  )

default

Copy assignment operator.

operator=() [2/2]

Block & ndn::Block::operator= ( Block &&  )

inlinedefaultnoexcept

Move assignment operator.

fromStream()

Block ndn::Block::fromStream ( std::istream &  is )

static

Parse Block from an input stream.

Exceptions

tlv::Error

TLV-LENGTH is zero or exceeds upper bound

Warning

If decoding fails, bytes are still consumed from the input stream.

Definition at line 162 of file block.cpp.

References begin(), Block(), end(), ndn::MAX_SIZE_OF_BLOCK_FROM_STREAM, NDN_THROW, ndn::tlv::readType(), ndn::tlv::readVarNumber(), ndn::tlv::sizeOfVarNumber(), and type().

Referenced by ns3::ndn::BlockHeader::Deserialize().

fromBuffer() [1/2]

std::tuple< bool, Block > ndn::Block::fromBuffer ( ConstBufferPtr  buffer, size_t  offset  )

static

Try to parse Block from a wire buffer.

Parameters

buffer	a Buffer containing a TLV element at offset offset
offset	begin position of the TLV element within buffer

Note

This function does not throw upon decoding failure.

Returns

true and the parsed Block if parsing succeeds; otherwise false and an invalid Block

Definition at line 194 of file block.cpp.

References begin(), Block(), nonstd::optional_lite::std11::move(), ndn::tlv::readType(), ndn::tlv::readVarNumber(), and type().

Referenced by nfd::face::StreamTransport< Protocol >::handleReceive(), ndn::nfd::parseDatasetVector(), nfd::face::DatagramTransport< Protocol, Addressing >::receiveDatagram(), nfd::face::WebSocketTransport::receiveMessage(), and nfd::face::EthernetTransport::receivePayload().

fromBuffer() [2/2]

std::tuple< bool, Block > ndn::Block::fromBuffer ( const uint8_t *  buf, size_t  bufSize  )

static

Try to parse Block from a raw buffer.

Parameters

buf	pointer to the first octet of a TLV element
bufSize	size of the raw buffer; may be greater than the actual size of the TLV element

Note

This function does not throw upon decoding failure.

This overload copies the TLV element octets into an internal wire buffer.

Returns

true and the parsed Block if parsing succeeds; otherwise false and an invalid Block

Definition at line 220 of file block.cpp.

References Block(), buf, end(), ndn::tlv::readType(), ndn::tlv::readVarNumber(), and type().

isValid()

bool ndn::Block::isValid ( ) const

inlinenoexcept

Check if the Block is valid.

A Block is valid unless it has an invalid TLV-TYPE or is default-constructed. In particular, a Block with zero-length TLV-VALUE is valid.

Definition at line 188 of file block.hpp.

References ndn::tlv::Invalid, and m_type.

Referenced by empty(), ndn::operator<<(), nfd::face::Transport::receive(), nfd::face::Transport::send(), ndn::Interest::setApplicationParameters(), and size().

empty()

NDN_CXX_NODISCARD bool ndn::Block::empty ( ) const

inlinenoexcept

Check if the Block is empty.

A Block is considered empty iff it is not valid, i.e., isValid() returns false.

Warning

Note that an empty Block is not the same as a valid but zero-length Block.

Deprecated:

Use Block::isValid()

Definition at line 201 of file block.hpp.

References isValid().

reset()

void ndn::Block::reset ( )

noexcept

Reset the Block to a default-constructed state.

Equivalent to *this = Block().

Postcondition

isValid() == false

See also

resetWire()

Definition at line 250 of file block.cpp.

Referenced by ndn::MetaInfo::addAppMetaInfo(), ndn::nfd::FibEntry::addNextHopRecord(), ndn::nfd::RibEntry::addRoute(), ndn::SignatureInfo::appendTypeSpecificTlv(), ndn::KeyLocator::clear(), ndn::nfd::FibEntry::clearNextHopRecords(), ndn::nfd::RibEntry::clearRoutes(), ndn::Interest::getNonce(), ndn::Interest::modifyForwardingHint(), ndn::Interest::refreshNonce(), ndn::MetaInfo::removeAppMetaInfo(), ndn::Data::resetWire(), ndn::Interest::setApplicationParameters(), ndn::MetaInfo::setAppMetaInfo(), ndn::nfd::FaceStatus::setBaseCongestionMarkingInterval(), ndn::nfd::ControlParameters::setBaseCongestionMarkingInterval(), ndn::mgmt::ControlResponse::setBody(), ndn::Interest::setCanBePrefix(), ndn::nfd::CsInfo::setCapacity(), ndn::nfd::ControlParameters::setCapacity(), ndn::mgmt::ControlResponse::setCode(), ndn::nfd::NextHopRecord::setCost(), ndn::nfd::Route::setCost(), ndn::nfd::ControlParameters::setCost(), ndn::nfd::ControlParameters::setCount(), ndn::nfd::ForwarderStatus::setCurrentTimestamp(), ndn::nfd::FaceStatus::setDefaultCongestionThreshold(), ndn::nfd::ControlParameters::setDefaultCongestionThreshold(), ndn::nfd::CsInfo::setEnableAdmit(), ndn::nfd::CsInfo::setEnableServe(), ndn::nfd::FaceStatus::setExpirationPeriod(), ndn::nfd::Route::setExpirationPeriod(), ndn::nfd::ControlParameters::setExpirationPeriod(), ndn::nfd::FaceTraits< FaceEventNotification >::setFaceId(), ndn::nfd::NextHopRecord::setFaceId(), ndn::nfd::Route::setFaceId(), ndn::nfd::FaceQueryFilter::setFaceId(), ndn::nfd::ControlParameters::setFaceId(), ndn::nfd::FaceTraits< FaceEventNotification >::setFacePersistency(), ndn::nfd::FaceQueryFilter::setFacePersistency(), ndn::nfd::ControlParameters::setFacePersistency(), ndn::nfd::FaceTraits< FaceEventNotification >::setFaceScope(), ndn::nfd::FaceQueryFilter::setFaceScope(), ndn::MetaInfo::setFinalBlock(), ndn::nfd::FaceTraits< FaceEventNotification >::setFlagBit(), ndn::nfd::Route::setFlags(), ndn::nfd::FaceTraits< FaceEventNotification >::setFlags(), ndn::nfd::ControlParameters::setFlags(), ndn::Interest::setForwardingHint(), ndn::MetaInfo::setFreshnessPeriod(), ndn::Interest::setHopLimit(), ndn::Interest::setInterestLifetime(), ndn::KeyLocator::setKeyDigest(), ndn::SignatureInfo::setKeyLocator(), ndn::nfd::FaceEventNotification::setKind(), ndn::nfd::FaceTraits< FaceEventNotification >::setLinkType(), ndn::nfd::FaceQueryFilter::setLinkType(), ndn::nfd::ChannelStatus::setLocalUri(), ndn::nfd::FaceTraits< FaceEventNotification >::setLocalUri(), ndn::nfd::FaceQueryFilter::setLocalUri(), ndn::nfd::ControlParameters::setLocalUri(), ndn::nfd::ControlParameters::setMask(), ndn::nfd::FaceStatus::setMtu(), ndn::nfd::ControlParameters::setMtu(), ndn::Interest::setMustBeFresh(), ndn::nfd::StrategyChoice::setName(), ndn::KeyLocator::setName(), ndn::nfd::ControlParameters::setName(), ndn::Interest::setName(), ndn::nfd::RibEntry::setName(), ndn::nfd::ForwarderStatus::setNCsEntries(), ndn::nfd::CsInfo::setNEntries(), ndn::nfd::FibEntry::setNextHopRecords(), ndn::nfd::ForwarderStatus::setNfdVersion(), ndn::nfd::ForwarderStatus::setNFibEntries(), ndn::nfd::CsInfo::setNHits(), ndn::nfd::FaceStatus::setNInBytes(), ndn::nfd::ForwarderStatus::setNInData(), ndn::nfd::FaceStatus::setNInData(), ndn::nfd::ForwarderStatus::setNInInterests(), ndn::nfd::FaceStatus::setNInInterests(), ndn::nfd::ForwarderStatus::setNInNacks(), ndn::nfd::FaceStatus::setNInNacks(), ndn::nfd::ForwarderStatus::setNMeasurementsEntries(), ndn::nfd::CsInfo::setNMisses(), ndn::nfd::ForwarderStatus::setNNameTreeEntries(), ndn::Interest::setNonce(), ndn::nfd::FaceStatus::setNOutBytes(), ndn::nfd::ForwarderStatus::setNOutData(), ndn::nfd::FaceStatus::setNOutData(), ndn::nfd::ForwarderStatus::setNOutInterests(), ndn::nfd::FaceStatus::setNOutInterests(), ndn::nfd::ForwarderStatus::setNOutNacks(), ndn::nfd::FaceStatus::setNOutNacks(), ndn::nfd::ForwarderStatus::setNPitEntries(), ndn::nfd::ForwarderStatus::setNSatisfiedInterests(), ndn::nfd::ForwarderStatus::setNUnsatisfiedInterests(), ndn::nfd::Route::setOrigin(), ndn::nfd::ControlParameters::setOrigin(), ndn::security::ValidityPeriod::setPeriod(), ndn::lp::CachePolicy::setPolicy(), ndn::nfd::FibEntry::setPrefix(), ndn::lp::NackHeader::setReason(), ndn::nfd::FaceTraits< FaceEventNotification >::setRemoteUri(), ndn::nfd::FaceQueryFilter::setRemoteUri(), ndn::nfd::RibEntry::setRoutes(), ndn::SignatureInfo::setSignatureType(), ndn::nfd::ForwarderStatus::setStartTimestamp(), ndn::nfd::StrategyChoice::setStrategy(), ndn::nfd::ControlParameters::setStrategy(), ndn::mgmt::ControlResponse::setText(), ndn::MetaInfo::setType(), ndn::nfd::ControlParameters::setUri(), ndn::nfd::FaceQueryFilter::setUriScheme(), ndn::Interest::unsetApplicationParameters(), ndn::nfd::FaceStatus::unsetBaseCongestionMarkingInterval(), ndn::nfd::ControlParameters::unsetBaseCongestionMarkingInterval(), ndn::nfd::ControlParameters::unsetCapacity(), ndn::nfd::ControlParameters::unsetCost(), ndn::nfd::ControlParameters::unsetCount(), ndn::nfd::FaceStatus::unsetDefaultCongestionThreshold(), ndn::nfd::ControlParameters::unsetDefaultCongestionThreshold(), ndn::nfd::FaceStatus::unsetExpirationPeriod(), ndn::nfd::Route::unsetExpirationPeriod(), ndn::nfd::ControlParameters::unsetExpirationPeriod(), ndn::nfd::FaceQueryFilter::unsetFaceId(), ndn::nfd::ControlParameters::unsetFaceId(), ndn::nfd::FaceQueryFilter::unsetFacePersistency(), ndn::nfd::ControlParameters::unsetFacePersistency(), ndn::nfd::FaceQueryFilter::unsetFaceScope(), ndn::nfd::ControlParameters::unsetFlags(), ndn::SignatureInfo::unsetKeyLocator(), ndn::nfd::FaceQueryFilter::unsetLinkType(), ndn::nfd::ControlParameters::unsetLocalUri(), ndn::nfd::ControlParameters::unsetMask(), ndn::nfd::FaceStatus::unsetMtu(), ndn::nfd::ControlParameters::unsetMtu(), ndn::nfd::ControlParameters::unsetName(), ndn::nfd::ControlParameters::unsetOrigin(), ndn::nfd::ControlParameters::unsetStrategy(), ndn::nfd::ControlParameters::unsetUri(), and ndn::SignatureInfo::unsetValidityPeriod().

resetWire()

void ndn::Block::resetWire ( )

noexcept

Reset wire buffer but keep TLV-TYPE and sub-elements (if any)

Postcondition

hasWire() == false

hasValue() == false

See also

reset()

Definition at line 256 of file block.cpp.

References m_begin, m_buffer, m_end, m_valueBegin, and m_valueEnd.

Referenced by ndn::Name::deepCopy(), erase(), insert(), push_back(), remove(), and ndn::Name::set().

hasWire()

bool ndn::Block::hasWire ( ) const

inlinenoexcept

Check if the Block contains a fully encoded wire representation.

A Block has a fully encoded wire if the underlying buffer exists and contains the full Type-Length-Value instead of just the TLV-VALUE field.

Definition at line 230 of file block.hpp.

References m_begin, m_buffer, and m_end.

Referenced by ndn::encoding::Encoder::appendBlock(), begin(), ndn::name::Component::compare(), encode(), end(), ndn::Data::getContent(), ndn::Data::getFullName(), ndn::Interest::hasWire(), ndn::Data::hasWire(), ndn::Name::hasWire(), ndn::encoding::Encoder::prependBlock(), ndn::encoding::Estimator::prependBlock(), wire(), ndn::security::ValidityPeriod::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), ndn::nfd::FaceEventNotification::wireEncode(), ndn::nfd::FaceStatus::wireEncode(), ndn::nfd::ChannelStatus::wireEncode(), ndn::nfd::StrategyChoice::wireEncode(), ndn::nfd::CsInfo::wireEncode(), ndn::nfd::FaceQueryFilter::wireEncode(), ndn::nfd::ForwarderStatus::wireEncode(), ndn::lp::GeoTag::wireEncode(), ndn::mgmt::ControlResponse::wireEncode(), ndn::lp::NackHeader::wireEncode(), ndn::nfd::NextHopRecord::wireEncode(), ndn::SignatureInfo::wireEncode(), ndn::lp::CachePolicy::wireEncode(), ndn::KeyLocator::wireEncode(), ndn::Interest::wireEncode(), ndn::MetaInfo::wireEncode(), ndn::Data::wireEncode(), ndn::nfd::ControlParameters::wireEncode(), ndn::security::ValidityPeriod::wireEncode(), ndn::security::v2::AdditionalDescription::wireEncode(), ndn::nfd::Route::wireEncode(), ndn::Name::wireEncode(), ndn::nfd::FibEntry::wireEncode(), ndn::nfd::RibEntry::wireEncode(), and ndn::name::Component::wireEncode().

begin()

Buffer::const_iterator ndn::Block::begin

(

)

const

Get begin iterator of encoded wire.

Precondition

hasWire() == true

Definition at line 263 of file block.cpp.

References hasWire(), m_begin, and NDN_THROW.

Referenced by fromBuffer(), fromStream(), parse(), and ndn::lp::Packet::wireDecode().

end()

Buffer::const_iterator ndn::Block::end

(

)

const

Get end iterator of encoded wire.

Precondition

hasWire() == true

Definition at line 272 of file block.cpp.

References hasWire(), m_end, and NDN_THROW.

Referenced by Block(), fromBuffer(), fromStream(), parse(), and ndn::lp::Packet::wireDecode().

wire()

const uint8_t * ndn::Block::wire

(

)

const

Return a raw pointer to the beginning of the encoded wire.

Precondition

hasWire() == true

See also

value()

Definition at line 281 of file block.cpp.

References hasWire(), m_begin, and NDN_THROW.

Referenced by ndn::mgmt::StatusDatasetContext::append(), ndn::encoding::Encoder::appendBlock(), ndn::util::Sqlite3Statement::bind(), ndn::name::Component::compare(), nfd::name_tree::computeHash(), nfd::name_tree::computeHashes(), ndn::Data::getFullName(), ndn::util::Sha256::operator<<(), ndn::encoding::Encoder::prependBlock(), ndn::io::saveBlock(), ndn::util::DummyClientFace::Transport::send(), nfd::face::InternalClientTransport::send(), and ndn::name::Component::wireDecode().

size()

size_t ndn::Block::size

(

)

const

Return the size of the encoded wire, i.e.

of the whole TLV

Precondition

isValid() == true

See also

value_size()

Definition at line 290 of file block.cpp.

References isValid(), m_size, and NDN_THROW.

Referenced by ndn::mgmt::StatusDatasetContext::append(), ndn::encoding::Encoder::appendBlock(), ndn::util::Sqlite3Statement::bind(), ndn::WireEncodable< X >::BOOST_CONCEPT_USAGE(), ndn::name::Component::compare(), nfd::name_tree::computeHash(), nfd::name_tree::computeHashes(), nfd::face::StreamTransport< Protocol >::doSend(), nfd::face::LpFragmenter::fragmentPacket(), ndn::Data::getFullName(), ndn::name::detail::ComponentType::getSuccessorImpl(), nfd::face::StreamTransport< Protocol >::handleReceive(), ndn::util::Sha256::operator<<(), ndn::security::parse(), ndn::nfd::parseDatasetVector(), nfd::face::LpReliability::piggyback(), ndn::encoding::Encoder::prependBlock(), ndn::encoding::Estimator::prependBlock(), nfd::face::Transport::receive(), nfd::face::DatagramTransport< Protocol, Addressing >::receiveDatagram(), nfd::face::InternalForwarderTransport::receivePacket(), nfd::face::InternalClientTransport::receivePacket(), ndn::io::saveBlock(), ndn::util::DummyClientFace::Transport::send(), nfd::face::InternalClientTransport::send(), nfd::face::Transport::send(), and ndn::Data::wireEncode().

getBuffer()

ConstBufferPtr ndn::Block::getBuffer ( ) const

inline

Get underlying buffer.

Definition at line 264 of file block.hpp.

References m_buffer.

type()

uint32_t ndn::Block::type ( ) const

inline

Return the TLV-TYPE of the Block.

Note

This will return tlv::Invalid if isValid() is false.

Definition at line 274 of file block.hpp.

References m_type.

Referenced by ndn::MetaInfo::addAppMetaInfo(), ndn::Name::append(), ndn::encoding::Encoder::appendBlock(), ndn::name::Component::compare(), ndn::lp::DecodeHelper< TlvType, EmptyValue >::decode(), ndn::lp::DecodeHelper< TlvType, uint64_t >::decode(), ndn::lp::FieldDecl< LOCATION, VALUE, TYPE, REPEATABLE, DECODER_TAG, ENCODER_TAG >::decode(), ndn::name::Component::equals(), find(), nfd::face::LpFragmenter::fragmentPacket(), fromBuffer(), ndn::name::Component::fromEscapedString(), ndn::name::Component::fromNumber(), fromStream(), get(), ndn::name::Component::getSuccessor(), ndn::name::detail::ComponentType::getSuccessorImpl(), ndn::name::Component::isByteOffset(), ndn::name::Component::isGeneric(), ndn::name::Component::isSegment(), ndn::name::Component::isSequenceNumber(), ndn::name::Component::isTimestamp(), ndn::name::Component::isVersion(), ndn::name::detail::Sha256ComponentType::match(), ndn::operator<<(), ndn::operator==(), parse(), nfd::face::LpReliability::piggyback(), ndn::encoding::Encoder::prependBlock(), ndn::encoding::Estimator::prependBlock(), ndn::encoding::readNonNegativeIntegerAs(), remove(), ndn::Interest::setApplicationParameters(), ndn::Data::setContent(), ndn::KeyLocator::setKeyDigest(), ndn::Signature::setValue(), ndn::name::Component::toByteOffset(), ndn::name::Component::toSegment(), ndn::name::Component::toSequenceNumber(), ndn::name::Component::toTimestamp(), ndn::name::Component::toUri(), ndn::name::Component::toVersion(), ndn::lp::Packet::wireDecode(), ndn::nfd::ChannelStatus::wireDecode(), ndn::nfd::FaceEventNotification::wireDecode(), ndn::nfd::FaceStatus::wireDecode(), ndn::nfd::StrategyChoice::wireDecode(), ndn::nfd::CsInfo::wireDecode(), ndn::lp::PrefixAnnouncementHeader::wireDecode(), ndn::nfd::FaceQueryFilter::wireDecode(), ndn::nfd::ForwarderStatus::wireDecode(), ndn::mgmt::ControlResponse::wireDecode(), ndn::lp::GeoTag::wireDecode(), ndn::lp::NackHeader::wireDecode(), ndn::nfd::NextHopRecord::wireDecode(), ndn::SignatureInfo::wireDecode(), ndn::DelegationList::wireDecode(), ndn::lp::CachePolicy::wireDecode(), ndn::KeyLocator::wireDecode(), ndn::Interest::wireDecode(), ndn::security::SafeBag::wireDecode(), ndn::nfd::ControlParameters::wireDecode(), ndn::security::ValidityPeriod::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), ndn::nfd::Route::wireDecode(), ndn::Name::wireDecode(), ndn::nfd::FibEntry::wireDecode(), ndn::nfd::RibEntry::wireDecode(), ndn::name::Component::wireEncode(), and ndn::name::detail::ComponentType::writeUri().

hasValue()

bool ndn::Block::hasValue ( ) const

inlinenoexcept

Check if the Block has a non-empty TLV-VALUE.

This property reflects whether the underlying buffer contains a TLV-VALUE. If this is false, TLV-VALUE has zero-length. If this is true, TLV-VALUE may be zero-length.

See also

value_size()

Definition at line 287 of file block.hpp.

References m_buffer.

Referenced by blockFromValue(), value(), and value_size().

value_begin()

Buffer::const_iterator ndn::Block::value_begin ( ) const

inline

Get begin iterator of TLV-VALUE.

Precondition

hasValue() == true

Definition at line 296 of file block.hpp.

References m_valueBegin.

Referenced by ndn::security::v2::KeyChain::addCertificate(), ndn::name::Component::equals(), parse(), ndn::encoding::readNonNegativeInteger(), ndn::name::Component::toNumberWithMarker(), and ndn::name::detail::ComponentType::writeUriEscapedValue().

value_end()

Buffer::const_iterator ndn::Block::value_end ( ) const

inline

Get end iterator of TLV-VALUE.

Precondition

hasValue() == true

Definition at line 305 of file block.hpp.

References m_valueEnd.

Referenced by ndn::security::v2::KeyChain::addCertificate(), ndn::name::Component::equals(), parse(), ndn::encoding::readNonNegativeInteger(), ndn::name::Component::toNumberWithMarker(), and ndn::name::detail::ComponentType::writeUriEscapedValue().

value()

const uint8_t * ndn::Block::value ( ) const

noexcept

Return a raw pointer to the beginning of TLV-VALUE.

See also

wire()

Definition at line 302 of file block.cpp.

References hasValue(), and m_valueBegin.

Referenced by ndn::security::pib::PibMemory::addCertificate(), ndn::security::pib::PibSqlite3::addCertificate(), ndn::encoding::Encoder::appendBlock(), ndn::name::Component::compare(), ndn::lp::DecodeHelper< TlvType, uint64_t >::decode(), ndn::name::Component::fromTimestamp(), ndn::name::Component::getSuccessor(), ndn::name::detail::ComponentType::getSuccessorImpl(), ndn::name::Component::isNumberWithMarker(), ndn::operator<<(), ndn::operator==(), ndn::security::parse(), ndn::encoding::Encoder::prependBlock(), ndn::encoding::Estimator::prependBlock(), ndn::encoding::readDouble(), ndn::encoding::readString(), ndn::name::Component::toTimestamp(), ndn::security::verifySignature(), ndn::name::Component::wireEncode(), and ndn::name::detail::ComponentType::writeUriEscapedValue().

value_size()

size_t ndn::Block::value_size ( ) const

noexcept

Return the size of TLV-VALUE, aka TLV-LENGTH.

See also

size()

Definition at line 308 of file block.cpp.

References hasValue(), m_valueBegin, and m_valueEnd.

Referenced by ndn::security::pib::PibMemory::addCertificate(), ndn::security::pib::PibSqlite3::addCertificate(), ndn::encoding::Encoder::appendBlock(), Block(), ndn::name::Component::compare(), ndn::lp::DecodeHelper< TlvType, EmptyValue >::decode(), ndn::lp::DecodeHelper< TlvType, uint64_t >::decode(), ndn::name::Component::empty(), ndn::name::Component::equals(), ndn::name::detail::ComponentType::getSuccessorImpl(), ndn::name::Component::isNumber(), ndn::name::Component::isNumberWithMarker(), ndn::name::detail::Sha256ComponentType::match(), ndn::operator<<(), ndn::operator==(), ndn::security::parse(), parse(), ndn::encoding::Encoder::prependBlock(), ndn::encoding::Estimator::prependBlock(), ndn::encoding::readDouble(), ndn::encoding::readNonNegativeInteger(), ndn::encoding::readString(), ndn::name::Component::toNumberWithMarker(), ndn::security::verifySignature(), ndn::name::Component::wireEncode(), and ndn::name::detail::ComponentType::writeUriEscapedValue().

blockFromValue()

Block ndn::Block::blockFromValue

(

)

const

Definition at line 314 of file block.cpp.

References Block(), hasValue(), m_valueBegin, m_valueEnd, and NDN_THROW.

Referenced by nfd::ManagerBase::extractRequester().

parse()

void ndn::Block::parse

(

)

const

Parse TLV-VALUE into sub-elements.

Postcondition

elements() reflects sub-elements found in TLV-VALUE

Exceptions

tlv::Error

TLV-VALUE is not a sequence of TLV elements

Note

This method does not perform recursive parsing.

This method has no effect if elements() is already populated.

This method is not really const, but it does not modify any data.

Definition at line 325 of file block.cpp.

References begin(), end(), m_buffer, m_elements, NDN_THROW, ndn::tlv::readType(), ndn::tlv::readVarNumber(), ndn::to_string(), type(), value_begin(), value_end(), and value_size().

Referenced by ndn::MetadataObject::MetadataObject(), ndn::Name::Name(), ndn::PrefixAnnouncement::PrefixAnnouncement(), ndn::lp::Packet::wireDecode(), ndn::nfd::FaceEventNotification::wireDecode(), ndn::nfd::ChannelStatus::wireDecode(), ndn::nfd::StrategyChoice::wireDecode(), ndn::nfd::FaceStatus::wireDecode(), ndn::nfd::CsInfo::wireDecode(), ndn::lp::PrefixAnnouncementHeader::wireDecode(), ndn::nfd::FaceQueryFilter::wireDecode(), ndn::nfd::ForwarderStatus::wireDecode(), ndn::mgmt::ControlResponse::wireDecode(), ndn::lp::GeoTag::wireDecode(), ndn::lp::NackHeader::wireDecode(), ndn::nfd::NextHopRecord::wireDecode(), ndn::SignatureInfo::wireDecode(), ndn::DelegationList::wireDecode(), ndn::lp::CachePolicy::wireDecode(), ndn::MetaInfo::wireDecode(), ndn::KeyLocator::wireDecode(), ndn::Interest::wireDecode(), ndn::security::SafeBag::wireDecode(), ndn::Data::wireDecode(), ndn::nfd::ControlParameters::wireDecode(), ndn::security::ValidityPeriod::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), ndn::nfd::Route::wireDecode(), ndn::Name::wireDecode(), ndn::nfd::FibEntry::wireDecode(), ndn::nfd::RibEntry::wireDecode(), ndn::security::ValidityPeriod::wireEncode(), ndn::security::v2::AdditionalDescription::wireEncode(), and ndn::Name::wireEncode().

encode()

void ndn::Block::encode

(

)

Encode sub-elements into TLV-VALUE.

Postcondition

TLV-VALUE contains sub-elements from elements()

Definition at line 353 of file block.cpp.

References hasWire().

Referenced by ndn::util::DummyClientFace::Transport::receive(), ndn::mgmt::ControlResponse::setBody(), ndn::security::v2::KeyChain::sign(), ndn::PrefixAnnouncement::toData(), ndn::lp::Packet::wireEncode(), and ndn::mgmt::ControlResponse::wireEncode().

get()

const Block & ndn::Block::get

(

uint32_t

type

)

const

Return the first sub-element of the specified TLV-TYPE.

Precondition

parse() has been executed

Exceptions

tlv::Error

a sub-element of the specified type does not exist

Definition at line 414 of file block.cpp.

References find(), m_elements, m_type, NDN_THROW, ndn::to_string(), and type().

Referenced by ndn::MetadataObject::MetadataObject(), ndn::PrefixAnnouncement::PrefixAnnouncement(), and ndn::lp::PrefixAnnouncementHeader::wireDecode().

find()

Block::element_const_iterator ndn::Block::find

(

uint32_t

type

)

const

Find the first sub-element of the specified TLV-TYPE.

Precondition

parse() has been executed

Returns

iterator in elements() to the found sub-element, or elements_end() if no such sub-element exists in elements()

Definition at line 426 of file block.cpp.

References m_elements, and type().

Referenced by ndn::name::Component::fromEscapedString(), get(), ndn::PrefixAnnouncement::PrefixAnnouncement(), and ndn::nfd::ControlParameters::wireDecode().

remove()

void ndn::Block::remove

(

uint32_t

type

)

Remove all sub-elements of the specified TLV-TYPE.

Precondition

parse() has been executed

Postcondition

find(type) == elements_end()

Definition at line 433 of file block.cpp.

References m_elements, resetWire(), and type().

Referenced by ndn::lp::Packet::clear().

erase() [1/2]

Block::element_iterator ndn::Block::erase

(

Block::element_const_iterator

position

)

Erase a sub-element.

Definition at line 443 of file block.cpp.

References m_elements, and resetWire().

Referenced by ndn::Name::erase(), and ndn::lp::Packet::remove().

erase() [2/2]

Block::element_iterator ndn::Block::erase	(	Block::element_const_iterator	first,
		Block::element_const_iterator	last
	)

Erase a range of sub-elements.

Definition at line 450 of file block.cpp.

References m_elements, and resetWire().

push_back()

void ndn::Block::push_back

(

const Block &

element

)

Append a sub-element.

Definition at line 457 of file block.cpp.

References m_elements, and resetWire().

Referenced by ndn::Name::append(), ndn::PrefixAnnouncement::toData(), and ndn::mgmt::ControlResponse::wireEncode().

insert()

Block::element_iterator ndn::Block::insert	(	Block::element_const_iterator	pos,
		const Block &	element
	)

Insert a sub-element.

Parameters

pos	position of the new sub-element
element	new sub-element to insert

Returns

iterator in elements() to the new sub-element

Definition at line 464 of file block.cpp.

References m_elements, and resetWire().

Referenced by ndn::lp::Packet::add().

elements()

const element_container& ndn::Block::elements ( ) const

inline

Get container of sub-elements.

Precondition

parse() has been executed

Definition at line 391 of file block.hpp.

References m_elements.

Referenced by ndn::Name::at(), ndn::Name::begin(), ndn::Name::empty(), ndn::Name::end(), nfd::face::LpFragmenter::fragmentPacket(), ndn::lp::Packet::get(), ndn::Name::get(), ndn::lp::Packet::list(), ndn::PrefixAnnouncement::PrefixAnnouncement(), ndn::Name::set(), ndn::lp::Packet::wireDecode(), ndn::lp::GeoTag::wireDecode(), ndn::DelegationList::wireDecode(), ndn::KeyLocator::wireDecode(), ndn::MetaInfo::wireDecode(), ndn::security::ValidityPeriod::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), and ndn::lp::Packet::wireEncode().

elements_begin()

element_const_iterator ndn::Block::elements_begin ( ) const

inline

Equivalent to elements().begin()

Definition at line 399 of file block.hpp.

References m_elements.

Referenced by ndn::lp::Packet::add(), ndn::lp::Packet::count(), ndn::Name::erase(), ndn::operator<<(), ndn::lp::Packet::remove(), ndn::nfd::ChannelStatus::wireDecode(), ndn::nfd::FaceEventNotification::wireDecode(), ndn::nfd::FaceStatus::wireDecode(), ndn::nfd::StrategyChoice::wireDecode(), ndn::nfd::CsInfo::wireDecode(), ndn::nfd::FaceQueryFilter::wireDecode(), ndn::nfd::ForwarderStatus::wireDecode(), ndn::mgmt::ControlResponse::wireDecode(), ndn::lp::NackHeader::wireDecode(), ndn::nfd::NextHopRecord::wireDecode(), ndn::SignatureInfo::wireDecode(), ndn::lp::CachePolicy::wireDecode(), ndn::KeyLocator::wireDecode(), ndn::Interest::wireDecode(), ndn::MetaInfo::wireDecode(), ndn::security::SafeBag::wireDecode(), ndn::Data::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), ndn::nfd::Route::wireDecode(), ndn::nfd::FibEntry::wireDecode(), and ndn::nfd::RibEntry::wireDecode().

elements_end()

element_const_iterator ndn::Block::elements_end ( ) const

inline

Equivalent to elements().end()

Definition at line 407 of file block.hpp.

References m_elements.

Referenced by ndn::lp::Packet::add(), ndn::lp::Packet::count(), ndn::operator<<(), ndn::PrefixAnnouncement::PrefixAnnouncement(), ndn::lp::Packet::remove(), ndn::nfd::ChannelStatus::wireDecode(), ndn::nfd::FaceEventNotification::wireDecode(), ndn::nfd::StrategyChoice::wireDecode(), ndn::nfd::FaceStatus::wireDecode(), ndn::nfd::CsInfo::wireDecode(), ndn::nfd::FaceQueryFilter::wireDecode(), ndn::mgmt::ControlResponse::wireDecode(), ndn::nfd::ForwarderStatus::wireDecode(), ndn::nfd::NextHopRecord::wireDecode(), ndn::SignatureInfo::wireDecode(), ndn::lp::CachePolicy::wireDecode(), ndn::MetaInfo::wireDecode(), ndn::Interest::wireDecode(), ndn::security::SafeBag::wireDecode(), ndn::Data::wireDecode(), ndn::nfd::ControlParameters::wireDecode(), ndn::security::v2::AdditionalDescription::wireDecode(), ndn::nfd::Route::wireDecode(), ndn::nfd::FibEntry::wireDecode(), and ndn::nfd::RibEntry::wireDecode().

elements_size()

size_t ndn::Block::elements_size ( ) const

inline

Equivalent to elements().size()

Definition at line 415 of file block.hpp.

References m_elements.

Referenced by ndn::lp::Packet::empty(), ndn::Name::size(), ndn::lp::NackHeader::wireDecode(), ndn::security::ValidityPeriod::wireDecode(), and ndn::security::v2::AdditionalDescription::wireDecode().

operator boost::asio::const_buffer()

ndn::Block::operator boost::asio::const_buffer

(

)

const

Implicit conversion to boost::asio::const_buffer

Definition at line 472 of file block.cpp.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const Block &  block  )

friend

Print block to os.

Default-constructed Block is printed as: [invalid]. Zero-length Block is printed as: TT[empty], where TT is TLV-TYPE in decimal. Non-zero-length Block on which parse() has not been called is printed as: TT[LL]=VVVV, where LL is TLV-LENGTH in decimal, and VVVV is TLV-VALUE in hexadecimal. Block on which parse() has been called is printed as: TT[LL]={SUB,SUB}, where each SUB is a sub-element printed using this format.

Definition at line 486 of file block.cpp.

Member Data Documentation

m_buffer

shared_ptr<const Buffer> ndn::Block::m_buffer

protected

Underlying buffer storing TLV-VALUE and possibly TLV-TYPE and TLV-LENGTH fields.

If m_buffer is nullptr, this is an invalid or zero-length Block with TLV-TYPE given in m_type. Otherwise,

• [m_valueBegin, m_valueEnd) point to the TLV-VALUE inside m_buffer.
• If m_begin != m_end, [m_begin, m_end) point to Type-Length-Value of this Block in m_buffer. Otherwise, m_buffer does not contain TLV-TYPE and TLV-LENGTH fields.

Definition at line 452 of file block.hpp.

Referenced by Block(), getBuffer(), hasValue(), hasWire(), parse(), and resetWire().

m_begin

Buffer::const_iterator ndn::Block::m_begin

protected

See also

m_buffer

Definition at line 453 of file block.hpp.

Referenced by begin(), Block(), hasWire(), resetWire(), and wire().

m_end

Buffer::const_iterator ndn::Block::m_end

protected

See also

m_buffer

Definition at line 454 of file block.hpp.

Referenced by Block(), end(), hasWire(), and resetWire().

m_valueBegin

Buffer::const_iterator ndn::Block::m_valueBegin

protected

See also

m_buffer

Definition at line 456 of file block.hpp.

Referenced by Block(), blockFromValue(), resetWire(), value(), value_begin(), and value_size().

m_valueEnd

Buffer::const_iterator ndn::Block::m_valueEnd

protected

See also

m_buffer

Definition at line 457 of file block.hpp.

Referenced by Block(), blockFromValue(), resetWire(), value_end(), and value_size().

m_type

uint32_t ndn::Block::m_type = tlv::Invalid

protected

TLV-TYPE.

Definition at line 459 of file block.hpp.

Referenced by Block(), get(), isValid(), and type().

m_size

size_t ndn::Block::m_size = 0

protected

Total size including Type-Length-Value.

This field is meaningful only if isValid() is true.

Definition at line 465 of file block.hpp.

Referenced by Block(), and size().

m_elements

element_container ndn::Block::m_elements

mutableprotected

Contains the sub-elements.

This field is valid only if parse() has been executed.

Definition at line 471 of file block.hpp.

Referenced by elements(), elements_begin(), elements_end(), elements_size(), erase(), find(), get(), insert(), ndn::operator<<(), parse(), push_back(), and remove().

---

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

• ndnSIM/ndn-cxx/ndn-cxx/encoding/block.hpp
• ndnSIM/ndn-cxx/ndn-cxx/encoding/block.cpp