ndn::tlv Namespace Reference

Namespace defining NDN Packet Format related constants and procedures. More...

Namespaces
	detail
	nfd
	security

Classes
class	Error
	represents an error in TLV encoding or decoding More...

Enumerations
enum	: uint32_t {   Invalid = 0,   Interest = 5,   Data = 6,   Name = 7,   GenericNameComponent = 8,   ImplicitSha256DigestComponent = 1,   ParametersSha256DigestComponent = 2,   CanBePrefix = 33,   MustBeFresh = 18,   ForwardingHint = 30,   Nonce = 10,   InterestLifetime = 12,   HopLimit = 34,   ApplicationParameters = 36,   MetaInfo = 20,   Content = 21,   SignatureInfo = 22,   SignatureValue = 23,   ContentType = 24,   FreshnessPeriod = 25,   FinalBlockId = 26,   SignatureType = 27,   KeyLocator = 28,   KeyDigest = 29,   LinkDelegation = 31,   LinkPreference = 30,   NameComponentMin = 1,   NameComponentMax = 65535,   AppPrivateBlock1 = 128,   AppPrivateBlock2 = 32767 }
	TLV-TYPE numbers defined in NDN Packet Format v0.3. More...
enum	: uint32_t {   Selectors = 9,   MinSuffixComponents = 13,   MaxSuffixComponents = 14,   PublisherPublicKeyLocator = 15,   Exclude = 16,   ChildSelector = 17,   Any = 19 }
	TLV-TYPE numbers defined in NDN Packet Format v0.2 but not in v0.3. More...
enum	: uint32_t {   KeywordNameComponent = 32,   SegmentNameComponent = 33,   ByteOffsetNameComponent = 34,   VersionNameComponent = 35,   TimestampNameComponent = 36,   SequenceNumNameComponent = 37 }
	TLV-TYPE numbers for typed name components. More...
enum	{   ValidityPeriod = 253,   NotBefore = 254,   NotAfter = 255,   AdditionalDescription = 258,   DescriptionEntry = 512,   DescriptionKey = 513,   DescriptionValue = 514 }
	TLV-TYPE numbers for SignatureInfo features. More...
enum	ContentTypeValue : uint32_t {   ContentType_Blob = 0,   ContentType_Link = 1,   ContentType_Key = 2,   ContentType_Nack = 3,   ContentType_Manifest = 4,   ContentType_PrefixAnn = 5,   ContentType_Flic = 1024 }
	ContentType values. More...
enum	SignatureTypeValue : uint16_t {   DigestSha256 = 0,   SignatureSha256WithRsa = 1,   SignatureSha256WithEcdsa = 3,   SignatureHmacWithSha256 = 4 }
	SignatureType values. More...

Functions
constexpr bool	isCriticalType (uint32_t type)
	Determine whether a TLV-TYPE is "critical" for evolvability purpose. More...
std::ostream &	operator<< (std::ostream &os, SignatureTypeValue st)
std::ostream &	operator<< (std::ostream &os, ContentTypeValue ct)
template<typename Iterator >
uint64_t	readNonNegativeInteger (size_t size, Iterator &begin, Iterator end)
	Read nonNegativeInteger in NDN-TLV encoding. More...
template<typename Iterator >
bool	readType (Iterator &begin, Iterator end, uint32_t &type) noexcept
	Read TLV-TYPE. More...
template<typename Iterator >
uint32_t	readType (Iterator &begin, Iterator end)
	Read TLV-TYPE. More...
template<typename Iterator >
bool	readVarNumber (Iterator &begin, Iterator end, uint64_t &number) noexcept
	Read VAR-NUMBER in NDN-TLV encoding. More...
template<typename Iterator >
uint64_t	readVarNumber (Iterator &begin, Iterator end)
	Read VAR-NUMBER in NDN-TLV encoding. More...
constexpr size_t	sizeOfNonNegativeInteger (uint64_t integer) noexcept
	Get the number of bytes necessary to hold the value of integer encoded as nonNegativeInteger. More...
constexpr size_t	sizeOfVarNumber (uint64_t number) noexcept
	Get the number of bytes necessary to hold the value of number encoded as VAR-NUMBER. More...
size_t	writeNonNegativeInteger (std::ostream &os, uint64_t integer)
	Write nonNegativeInteger to the specified stream. More...
size_t	writeVarNumber (std::ostream &os, uint64_t number)
	Write VAR-NUMBER to the specified stream. More...

Variables
constexpr int	NameComponent = GenericNameComponent

Detailed Description

Namespace defining NDN Packet Format related constants and procedures.

Enumeration Type Documentation

anonymous enum : uint32_t

TLV-TYPE numbers defined in NDN Packet Format v0.3.

See also

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

Enumerator
Invalid
Interest
Data
Name
GenericNameComponent
ImplicitSha256DigestComponent
ParametersSha256DigestComponent
CanBePrefix
MustBeFresh
ForwardingHint
Nonce
InterestLifetime
HopLimit
ApplicationParameters
MetaInfo
Content
SignatureInfo
SignatureValue
ContentType
FreshnessPeriod
FinalBlockId
SignatureType
KeyLocator
KeyDigest
LinkDelegation
LinkPreference
NameComponentMin
NameComponentMax
AppPrivateBlock1
AppPrivateBlock2

Definition at line 63 of file tlv.hpp.

anonymous enum : uint32_t

TLV-TYPE numbers defined in NDN Packet Format v0.2 but not in v0.3.

See also

https://named-data.net/doc/NDN-packet-spec/0.2.1/types.html

Enumerator
Selectors
MinSuffixComponents
MaxSuffixComponents
PublisherPublicKeyLocator
Exclude
ChildSelector
Any

Definition at line 101 of file tlv.hpp.

anonymous enum : uint32_t

TLV-TYPE numbers for typed name components.

See also

https://redmine.named-data.net/projects/ndn-tlv/wiki/NameComponentType

Enumerator
KeywordNameComponent
SegmentNameComponent
ByteOffsetNameComponent
VersionNameComponent
TimestampNameComponent
SequenceNumNameComponent

Definition at line 117 of file tlv.hpp.

anonymous enum

TLV-TYPE numbers for SignatureInfo features.

See also

docs/specs/certificate-format.rst

Enumerator
ValidityPeriod
NotBefore
NotAfter
AdditionalDescription
DescriptionEntry
DescriptionKey
DescriptionValue

Definition at line 142 of file tlv.hpp.

enum ndn::tlv::ContentTypeValue : uint32_t

ContentType values.

See also

https://redmine.named-data.net/projects/ndn-tlv/wiki/ContentType

Enumerator
ContentType_Blob	payload
ContentType_Link	another name that identifies the actual data content
ContentType_Key	public key, certificate
ContentType_Nack	application-level nack
ContentType_Manifest
ContentType_PrefixAnn	prefix announcement
ContentType_Flic	File-Like ICN Collection.

Definition at line 156 of file tlv.hpp.

enum ndn::tlv::SignatureTypeValue : uint16_t

SignatureType values.

See also

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

Enumerator
DigestSha256
SignatureSha256WithRsa
SignatureSha256WithEcdsa
SignatureHmacWithSha256

Definition at line 129 of file tlv.hpp.

Function Documentation

constexpr bool ndn::tlv::isCriticalType

(

uint32_t

type

)

Determine whether a TLV-TYPE is "critical" for evolvability purpose.

See also

https://named-data.net/doc/NDN-packet-spec/0.3/tlv.html#considerations-for-evolvability-of-tlv-based-encoding

Definition at line 174 of file tlv.hpp.

std::ostream & ndn::tlv::operator<<	(	std::ostream &	os,
		SignatureTypeValue	st
	)

Definition at line 33 of file tlv.cpp.

std::ostream & ndn::tlv::operator<<	(	std::ostream &	os,
		ContentTypeValue	ct
	)

Definition at line 49 of file tlv.cpp.

template<typename Iterator >

uint64_t ndn::tlv::readNonNegativeInteger	(	size_t	size,
		Iterator &	begin,
		Iterator	end
	)

Read nonNegativeInteger in NDN-TLV encoding.

Template Parameters

Iterator

an iterator or pointer that dereferences to uint8_t or compatible type

Parameters

[in]	size	size of the nonNegativeInteger
[in,out]	begin	Begin of the buffer, will be incremented to point to the first byte after the read nonNegativeInteger
[in]	end	End of the buffer

Exceptions

tlv::Error

number cannot be read

Note

How many bytes to read is directly controlled by size, which can be either 1, 2, 4, or 8. If size differs from std::distance(begin, end), tlv::Error exception will be thrown.

Definition at line 487 of file tlv.hpp.

template<typename Iterator >

bool ndn::tlv::readType ( Iterator &  begin, Iterator  end, uint32_t &  type  )

noexcept

Read TLV-TYPE.

Template Parameters

Iterator

an iterator or pointer that dereferences to uint8_t or compatible type

Parameters

[in,out]	begin	Begin of the buffer, will be incremented to point to the first byte after the read TLV-TYPE
[in]	end	End of the buffer
[out]	type	Read TLV-TYPE

Returns

true if TLV-TYPE was successfully read from input, false otherwise

Note

This function is largely equivalent to readVarNumber(), except that it returns false if the TLV-TYPE is zero or larger than 2^32-1 (maximum allowed by the packet format).

Definition at line 409 of file tlv.hpp.

template<typename Iterator >

uint32_t ndn::tlv::readType	(	Iterator &	begin,
		Iterator	end
	)

Read TLV-TYPE.

Template Parameters

Iterator

an iterator or pointer that dereferences to uint8_t or compatible type

Parameters

[in,out]	begin	Begin of the buffer, will be incremented to point to the first byte after the read TLV-TYPE
[in]	end	End of the buffer

Exceptions

tlv::Error

TLV-TYPE cannot be read

Note

This function is largely equivalent to readVarNumber(), except that it throws if the TLV-TYPE is zero or larger than 2^32-1 (maximum allowed by the packet format).

Definition at line 440 of file tlv.hpp.

template<typename Iterator >

bool ndn::tlv::readVarNumber ( Iterator &  begin, Iterator  end, uint64_t &  number  )

noexcept

Read VAR-NUMBER in NDN-TLV encoding.

Template Parameters

Iterator

an iterator or pointer that dereferences to uint8_t or compatible type

Parameters

[in,out]	begin	Begin of the buffer, will be incremented to point to the first byte after the read VAR-NUMBER
[in]	end	End of the buffer
[out]	number	Read VAR-NUMBER

Returns

true if number was successfully read from input, false otherwise

Definition at line 390 of file tlv.hpp.

template<typename Iterator >

uint64_t ndn::tlv::readVarNumber	(	Iterator &	begin,
		Iterator	end
	)

Read VAR-NUMBER in NDN-TLV encoding.

Template Parameters

Iterator

an iterator or pointer that dereferences to uint8_t or compatible type

Parameters

[in,out]	begin	Begin of the buffer, will be incremented to point to the first byte after the read VAR-NUMBER
[in]	end	End of the buffer

Exceptions

tlv::Error

VAR-NUMBER cannot be read

Definition at line 423 of file tlv.hpp.

constexpr size_t ndn::tlv::sizeOfNonNegativeInteger ( uint64_t  integer )

noexcept

Get the number of bytes necessary to hold the value of integer encoded as nonNegativeInteger.

Definition at line 503 of file tlv.hpp.

constexpr size_t ndn::tlv::sizeOfVarNumber ( uint64_t  number )

noexcept

Get the number of bytes necessary to hold the value of number encoded as VAR-NUMBER.

Definition at line 451 of file tlv.hpp.

size_t ndn::tlv::writeNonNegativeInteger ( std::ostream &  os, uint64_t  integer  )

inline

Write nonNegativeInteger to the specified stream.

Returns

length of written nonNegativeInteger

Definition at line 511 of file tlv.hpp.

size_t ndn::tlv::writeVarNumber ( std::ostream &  os, uint64_t  number  )

inline

Write VAR-NUMBER to the specified stream.

Returns

length of written VAR-NUMBER

Definition at line 459 of file tlv.hpp.

Variable Documentation

constexpr int ndn::tlv::NameComponent = GenericNameComponent

Definition at line 112 of file tlv.hpp.