NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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, InterestSignatureInfo = 44, InterestSignatureValue = 46,
  MetaInfo = 20, Content = 21, SignatureInfo = 22, SignatureValue = 23,
  ContentType = 24, FreshnessPeriod = 25, FinalBlockId = 26, SignatureType = 27,
  KeyLocator = 28, KeyDigest = 29, SignatureNonce = 38, SignatureTime = 40,
  SignatureSeqNum = 42, LinkDelegation = 31, LinkPreference = 30, NameComponentMin = 1,
  NameComponentMax = 65535, AppPrivateBlock1 = 128, AppPrivateBlock2 = 32768
}
 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 = 50, ByteOffsetNameComponent = 52, VersionNameComponent = 54,
  TimestampNameComponent = 56, SequenceNumNameComponent = 58
}
 TLV-TYPE numbers for typed name components. More...
 
enum  SignatureTypeValue : uint16_t {
  DigestSha256 = 0, SignatureSha256WithRsa = 1, SignatureSha256WithEcdsa = 3, SignatureHmacWithSha256 = 4,
  NullSignature = 200
}
 SignatureType values. More...
 
enum  : uint32_t {
  ValidityPeriod = 253, NotBefore = 254, NotAfter = 255, AdditionalDescription = 258,
  DescriptionEntry = 512, DescriptionKey = 513, DescriptionValue = 514
}
 TLV-TYPE numbers for SignatureInfo extensions. 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...
 

Functions

std::ostream & operator<< (std::ostream &os, SignatureTypeValue st)
 
std::ostream & operator<< (std::ostream &os, ContentTypeValue ct)
 
constexpr bool isCriticalType (uint32_t type)
 Determine whether a TLV-TYPE is "critical" for evolvability purpose. More...
 
template<typename Iterator >
NDN_CXX_NODISCARD bool readVarNumber (Iterator &begin, Iterator end, uint64_t &number) noexcept
 Read VAR-NUMBER in NDN-TLV encoding. More...
 
template<typename Iterator >
NDN_CXX_NODISCARD bool readType (Iterator &begin, Iterator end, uint32_t &type) noexcept
 Read TLV-TYPE. More...
 
template<typename Iterator >
uint64_t readVarNumber (Iterator &begin, Iterator end)
 Read VAR-NUMBER in NDN-TLV encoding. More...
 
template<typename Iterator >
uint32_t readType (Iterator &begin, Iterator end)
 Read TLV-TYPE. 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 writeVarNumber (std::ostream &os, uint64_t number)
 Write VAR-NUMBER to the specified stream. More...
 
template<typename Iterator >
uint64_t readNonNegativeInteger (size_t size, Iterator &begin, Iterator end)
 Read a NonNegativeInteger 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...
 
size_t writeNonNegativeInteger (std::ostream &os, uint64_t integer)
 Write a NonNegativeInteger to the specified stream. 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 >
bool readType (Iterator &begin, Iterator end, uint32_t &type) noexcept
 Read TLV-TYPE. More...
 

Detailed Description

Namespace defining NDN Packet Format related constants and procedures.

Enumeration Type Documentation

◆ anonymous enum

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 
InterestSignatureInfo 
InterestSignatureValue 
MetaInfo 
Content 
SignatureInfo 
SignatureValue 
ContentType 
FreshnessPeriod 
FinalBlockId 
SignatureType 
KeyLocator 
KeyDigest 
SignatureNonce 
SignatureTime 
SignatureSeqNum 
LinkDelegation 
LinkPreference 
NameComponentMin 
NameComponentMax 
AppPrivateBlock1 
AppPrivateBlock2 

Definition at line 63 of file tlv.hpp.

◆ anonymous enum

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 106 of file tlv.hpp.

◆ anonymous enum

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 119 of file tlv.hpp.

◆ SignatureTypeValue

SignatureType values.

See also
https://named-data.net/doc/NDN-packet-spec/current/signature.html
https://redmine.named-data.net/projects/ndn-tlv/wiki/SignatureType
Enumerator
DigestSha256 
SignatureSha256WithRsa 
SignatureSha256WithEcdsa 
SignatureHmacWithSha256 
NullSignature 

Definition at line 132 of file tlv.hpp.

◆ anonymous enum

anonymous enum : uint32_t

TLV-TYPE numbers for SignatureInfo extensions.

See also
NDN Certificate Format
Enumerator
ValidityPeriod 
NotBefore 
NotAfter 
AdditionalDescription 
DescriptionEntry 
DescriptionKey 
DescriptionValue 

Definition at line 146 of file tlv.hpp.

◆ ContentTypeValue

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 160 of file tlv.hpp.

Function Documentation

◆ operator<<() [1/2]

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

◆ operator<<() [2/2]

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

◆ isCriticalType()

◆ readVarNumber() [1/3]

template<typename Iterator >
NDN_CXX_NODISCARD bool ndn::tlv::readVarNumber ( Iterator &  begin,
Iterator  end,
uint64_t &  number 
)
noexcept

Read VAR-NUMBER in NDN-TLV encoding.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read VAR-NUMBER
[in]endEnd of the buffer
[out]numberRead VAR-NUMBER
Returns
true if number was successfully read from input, false otherwise

Definition at line 393 of file tlv.hpp.

Referenced by ndn::Block::Block(), ndn::Block::fromBuffer(), ndn::Block::fromStream(), isCriticalType(), ndn::Block::parse(), readType(), and readVarNumber().

◆ readType() [1/3]

template<typename Iterator >
NDN_CXX_NODISCARD bool ndn::tlv::readType ( Iterator &  begin,
Iterator  end,
uint32_t &  type 
)
noexcept

Read TLV-TYPE.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read TLV-TYPE
[in]endEnd of the buffer
[out]typeRead 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 412 of file tlv.hpp.

References Invalid, and readVarNumber().

Referenced by ndn::Block::Block(), ndn::Block::fromBuffer(), ndn::Block::fromStream(), isCriticalType(), and ndn::Block::parse().

◆ readVarNumber() [2/3]

template<typename Iterator >
uint64_t ndn::tlv::readVarNumber ( Iterator &  begin,
Iterator  end 
)

Read VAR-NUMBER in NDN-TLV encoding.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read VAR-NUMBER
[in]endEnd of the buffer
Exceptions
tlv::ErrorVAR-NUMBER cannot be read

Definition at line 426 of file tlv.hpp.

References ndn::tlv::Error::Error(), NDN_THROW, and readVarNumber().

◆ readType() [2/3]

template<typename Iterator >
uint32_t ndn::tlv::readType ( Iterator &  begin,
Iterator  end 
)

Read TLV-TYPE.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read TLV-TYPE
[in]endEnd of the buffer
Exceptions
tlv::ErrorTLV-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 443 of file tlv.hpp.

References ndn::tlv::Error::Error(), Invalid, NDN_THROW, readVarNumber(), and ndn::to_string().

◆ sizeOfVarNumber()

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 454 of file tlv.hpp.

Referenced by ndn::encoding::Estimator::appendVarNumber(), ndn::Block::Block(), ndn::Block::fromStream(), isCriticalType(), nfd::face::LpReliability::piggyback(), and ndn::encoding::Estimator::prependVarNumber().

◆ writeVarNumber()

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 462 of file tlv.hpp.

Referenced by isCriticalType().

◆ readNonNegativeInteger()

template<typename Iterator >
uint64_t ndn::tlv::readNonNegativeInteger ( size_t  size,
Iterator &  begin,
Iterator  end 
)

Read a NonNegativeInteger in NDN-TLV encoding.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in]sizesize of the NonNegativeInteger
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read NonNegativeInteger
[in]endEnd of the buffer
Exceptions
tlv::Errornumber 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 490 of file tlv.hpp.

References ndn::tlv::Error::Error(), NDN_THROW, and ndn::to_string().

Referenced by isCriticalType(), ndn::encoding::readNonNegativeInteger(), and ndn::name::Component::toNumberWithMarker().

◆ sizeOfNonNegativeInteger()

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 506 of file tlv.hpp.

Referenced by ndn::encoding::Estimator::appendNonNegativeInteger(), isCriticalType(), and ndn::encoding::Estimator::prependNonNegativeInteger().

◆ writeNonNegativeInteger()

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

Write a NonNegativeInteger to the specified stream.

Returns
length of written NonNegativeInteger

Definition at line 514 of file tlv.hpp.

Referenced by isCriticalType().

◆ readVarNumber() [3/3]

template<typename Iterator >
bool ndn::tlv::readVarNumber ( Iterator &  begin,
Iterator  end,
uint64_t &  number 
)
noexcept

Read VAR-NUMBER in NDN-TLV encoding.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read VAR-NUMBER
[in]endEnd of the buffer
[out]numberRead VAR-NUMBER
Returns
true if number was successfully read from input, false otherwise

Definition at line 393 of file tlv.hpp.

Referenced by ndn::Block::Block(), ndn::Block::fromBuffer(), ndn::Block::fromStream(), isCriticalType(), ndn::Block::parse(), readType(), and readVarNumber().

◆ readType() [3/3]

template<typename Iterator >
bool ndn::tlv::readType ( Iterator &  begin,
Iterator  end,
uint32_t &  type 
)
noexcept

Read TLV-TYPE.

Template Parameters
Iteratoran iterator or pointer that dereferences to uint8_t or compatible type
Parameters
[in,out]beginBegin of the buffer, will be incremented to point to the first byte after the read TLV-TYPE
[in]endEnd of the buffer
[out]typeRead 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 412 of file tlv.hpp.

References Invalid, and readVarNumber().

Referenced by ndn::Block::Block(), ndn::Block::fromBuffer(), ndn::Block::fromStream(), isCriticalType(), and ndn::Block::parse().