ndn::lp Namespace Reference

Namespaces

 field_location_tags
 indicates where a field may occur
 
 tlv
 

Classes

class  CachePolicy
 represents a CachePolicy header field More...
 
struct  DecodeHelper
 
struct  DecodeHelper< TlvType, EmptyValue >
 
struct  DecodeHelper< TlvType, NonNegativeIntegerTag >
 
struct  DecodeHelper< TlvType, std::pair< Buffer::const_iterator, Buffer::const_iterator > >
 
struct  DecodeHelper< TlvType, uint64_t >
 
struct  EmptyValue
 represents a zero-length TLV-VALUE More...
 
struct  EncodeHelper
 
struct  EncodeHelper< TAG, TlvType, EmptyValue >
 
struct  EncodeHelper< TAG, TlvType, NonNegativeIntegerTag >
 
struct  EncodeHelper< TAG, TlvType, std::pair< Buffer::const_iterator, Buffer::const_iterator > >
 
struct  EncodeHelper< TAG, TlvType, uint64_t >
 
struct  Field
 concept check for fields More...
 
class  FieldDecl
 Declare a field. More...
 
class  Nack
 represents a Network Nack More...
 
class  NackHeader
 represents a Network NACK header More...
 
class  Packet
 
class  PitToken
 represent a PIT token field More...
 
class  PrefixAnnouncementHeader
 represents a PrefixAnnouncement header field in NDNLP More...
 

Typedefs

typedef FieldDecl< field_location_tags::Header, Sequence, tlv::Ack, true > AckField
 
typedef FieldDecl< field_location_tags::Header, CachePolicy, tlv::CachePolicyCachePolicyField
 
typedef SimpleTag< CachePolicy, 12 > CachePolicyTag
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::CongestionMark, false, NonNegativeIntegerTag, NonNegativeIntegerTag > CongestionMarkField
 
typedef SimpleTag< uint64_t, 13 > CongestionMarkTag
 
typedef boost::mpl::set< FragmentField, SequenceField, FragIndexField, FragCountField, PitTokenField, NackField, NextHopFaceIdField, IncomingFaceIdField, CachePolicyField, CongestionMarkField, AckField, TxSequenceField, NonDiscoveryField, PrefixAnnouncementFieldFieldSet
 Set of all field declarations. More...
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::FragCount, false, NonNegativeIntegerTag, NonNegativeIntegerTag > FragCountField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::FragIndex, false, NonNegativeIntegerTag, NonNegativeIntegerTag > FragIndexField
 
typedef FieldDecl< field_location_tags::Fragment, std::pair< Buffer::const_iterator, Buffer::const_iterator >, tlv::FragmentFragmentField
 Declare the Fragment field. More...
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::IncomingFaceId, false, NonNegativeIntegerTag, NonNegativeIntegerTag > IncomingFaceIdField
 
typedef SimpleTag< uint64_t, 10 > IncomingFaceIdTag
 
typedef FieldDecl< field_location_tags::Header, NackHeader, tlv::NackNackField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::NextHopFaceId, false, NonNegativeIntegerTag, NonNegativeIntegerTag > NextHopFaceIdField
 
typedef SimpleTag< uint64_t, 11 > NextHopFaceIdTag
 
typedef FieldDecl< field_location_tags::Header, EmptyValue, tlv::NonDiscoveryNonDiscoveryField
 
typedef SimpleTag< EmptyValue, 14 > NonDiscoveryTag
 
typedef FieldDecl< field_location_tags::Header, std::pair< Buffer::const_iterator, Buffer::const_iterator >, tlv::PitTokenPitTokenField
 
typedef FieldDecl< field_location_tags::Header, PrefixAnnouncementHeader, tlv::PrefixAnnouncementPrefixAnnouncementField
 
typedef SimpleTag< PrefixAnnouncementHeader, 15 > PrefixAnnouncementTag
 
typedef uint64_t Sequence
 represents a sequence number More...
 
typedef FieldDecl< field_location_tags::Header, Sequence, tlv::SequenceSequenceField
 
typedef FieldDecl< field_location_tags::Header, Sequence, tlv::TxSequenceTxSequenceField
 

Enumerations

enum  CachePolicyType {
  CachePolicyType::NONE = 0,
  CachePolicyType::NO_CACHE = 1
}
 indicates the cache policy applied to a Data packet More...
 
enum  NackReason {
  NackReason::NONE = 0,
  NackReason::CONGESTION = 50,
  NackReason::DUPLICATE = 100,
  NackReason::NO_ROUTE = 150
}
 indicates the reason type of a network NACK More...
 

Functions

template size_t CachePolicy ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t CachePolicy ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
bool isLessSevere (lp::NackReason x, lp::NackReason y)
 compare NackReason for severity More...
 
template size_t NackHeader ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t NackHeader ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 
std::ostream & operator<< (std::ostream &os, NackReason reason)
 
std::ostream & operator<< (std::ostream &os, CachePolicyType policy)
 
std::ostream & operator<< (std::ostream &os, const PitToken &pitToken)
 
template size_t PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EncoderTag > (::ndn::EncodingBuffer &) const
 
template size_t PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EstimatorTag > (::ndn::EncodingEstimator &) const
 

Variables

static constexpr size_t LENGTH_MAX = 32
 
static constexpr size_t LENGTH_MIN = 1
 

Typedef Documentation

◆ AckField

◆ CachePolicyField

◆ CachePolicyTag

Definition at line 52 of file tags.hpp.

◆ CongestionMarkField

typedef FieldDecl<field_location_tags::Header, uint64_t, tlv::CongestionMark, false, NonNegativeIntegerTag, NonNegativeIntegerTag> ndn::lp::CongestionMarkField

Definition at line 86 of file fields.hpp.

◆ CongestionMarkTag

typedef SimpleTag<uint64_t, 13> ndn::lp::CongestionMarkTag

Definition at line 59 of file tags.hpp.

◆ FieldSet

◆ FragCountField

typedef FieldDecl<field_location_tags::Header, uint64_t, tlv::FragCount, false, NonNegativeIntegerTag, NonNegativeIntegerTag> ndn::lp::FragCountField

Definition at line 47 of file fields.hpp.

◆ FragIndexField

typedef FieldDecl<field_location_tags::Header, uint64_t, tlv::FragIndex, false, NonNegativeIntegerTag, NonNegativeIntegerTag> ndn::lp::FragIndexField

Definition at line 39 of file fields.hpp.

◆ FragmentField

typedef FieldDecl<field_location_tags::Fragment, std::pair<Buffer::const_iterator, Buffer::const_iterator>, tlv::Fragment> ndn::lp::FragmentField

Declare the Fragment field.

The fragment (i.e. payload) is the bytes between two provided iterators. During encoding, these bytes are copied from the Buffer into the LpPacket.

Definition at line 115 of file fields.hpp.

◆ IncomingFaceIdField

typedef FieldDecl<field_location_tags::Header, uint64_t, tlv::IncomingFaceId, false, NonNegativeIntegerTag, NonNegativeIntegerTag> ndn::lp::IncomingFaceIdField

Definition at line 78 of file fields.hpp.

◆ IncomingFaceIdTag

typedef SimpleTag<uint64_t, 10> ndn::lp::IncomingFaceIdTag

Definition at line 38 of file tags.hpp.

◆ NackField

◆ NextHopFaceIdField

typedef FieldDecl<field_location_tags::Header, uint64_t, tlv::NextHopFaceId, false, NonNegativeIntegerTag, NonNegativeIntegerTag> ndn::lp::NextHopFaceIdField

Definition at line 65 of file fields.hpp.

◆ NextHopFaceIdTag

typedef SimpleTag<uint64_t, 11> ndn::lp::NextHopFaceIdTag

Definition at line 45 of file tags.hpp.

◆ NonDiscoveryField

◆ NonDiscoveryTag

Definition at line 66 of file tags.hpp.

◆ PitTokenField

typedef FieldDecl<field_location_tags::Header, std::pair<Buffer::const_iterator, Buffer::const_iterator>, tlv::PitToken> ndn::lp::PitTokenField

Definition at line 55 of file fields.hpp.

◆ PrefixAnnouncementField

◆ PrefixAnnouncementTag

◆ Sequence

typedef uint64_t ndn::lp::Sequence

represents a sequence number

Definition at line 35 of file sequence.hpp.

◆ SequenceField

◆ TxSequenceField

Enumeration Type Documentation

◆ CachePolicyType

indicates the cache policy applied to a Data packet

Enumerator
NONE 
NO_CACHE 

Definition at line 36 of file cache-policy.hpp.

◆ NackReason

enum ndn::lp::NackReason
strong

indicates the reason type of a network NACK

Enumerator
NONE 
CONGESTION 
DUPLICATE 
NO_ROUTE 

Definition at line 37 of file nack-header.hpp.

Function Documentation

◆ CachePolicy ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::lp::CachePolicy ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const

◆ CachePolicy ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::lp::CachePolicy ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const

◆ isLessSevere()

bool ndn::lp::isLessSevere ( lp::NackReason  x,
lp::NackReason  y 
)

compare NackReason for severity

lp::NackReason::NONE is treated as most severe

Definition at line 45 of file nack-header.cpp.

◆ NackHeader ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::lp::NackHeader ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const

◆ NackHeader ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::lp::NackHeader ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const

◆ operator<<() [1/3]

std::ostream & ndn::lp::operator<< ( std::ostream &  os,
NackReason  reason 
)

Definition at line 30 of file nack-header.cpp.

◆ operator<<() [2/3]

std::ostream & ndn::lp::operator<< ( std::ostream &  os,
CachePolicyType  policy 
)

Definition at line 31 of file cache-policy.cpp.

◆ operator<<() [3/3]

std::ostream & ndn::lp::operator<< ( std::ostream &  os,
const PitToken pitToken 
)

Definition at line 42 of file pit-token.cpp.

◆ PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EncoderTag >()

template size_t ndn::lp::PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EncoderTag > ( ::ndn::EncodingBuffer &  ) const

◆ PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EstimatorTag >()

template size_t ndn::lp::PrefixAnnouncementHeader ::wireEncode<::ndn::encoding::EstimatorTag > ( ::ndn::EncodingEstimator &  ) const

Variable Documentation

◆ LENGTH_MAX

constexpr size_t ndn::lp::LENGTH_MAX = 32
static

Definition at line 30 of file pit-token.cpp.

◆ LENGTH_MIN

constexpr size_t ndn::lp::LENGTH_MIN = 1
static

Definition at line 29 of file pit-token.cpp.