NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
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, std::pair< Buffer::const_iterator, Buffer::const_iterator > >
 
struct  DecodeHelper< TlvType, uint64_t >
 
struct  EncodeHelper
 
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
 
class  Nack
 represents a Network Nack More...
 
class  NackHeader
 represents a Network NACK header More...
 
class  Packet
 

Typedefs

typedef FieldDecl< field_location_tags::Header, Sequence, tlv::SequenceSequenceField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::FragIndexFragIndexField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::FragCountFragCountField
 
typedef FieldDecl< field_location_tags::Header, NackHeader, tlv::NackNackField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::NextHopFaceIdNextHopFaceIdField
 
typedef FieldDecl< field_location_tags::Header, CachePolicy, tlv::CachePolicyCachePolicyField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::IncomingFaceIdIncomingFaceIdField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::CongestionMarkCongestionMarkField
 
typedef FieldDecl< field_location_tags::Header, Sequence, tlv::Ack, true > AckField
 
typedef FieldDecl< field_location_tags::Header, Sequence, tlv::TxSequenceTxSequenceField
 
typedef FieldDecl< field_location_tags::Header, uint64_t, tlv::HopCountTagHopCountTagField
 
typedef FieldDecl< field_location_tags::Fragment, std::pair< Buffer::const_iterator, Buffer::const_iterator >, tlv::FragmentFragmentField
 The value of the wire encoded field is the data between the provided iterators. More...
 
typedef boost::mpl::set< FragmentField, SequenceField, FragIndexField, FragCountField, NackField, NextHopFaceIdField, CachePolicyField, IncomingFaceIdField, CongestionMarkField, AckField, TxSequenceField, HopCountTagFieldFieldSet
 set of all field declarations More...
 
typedef uint64_t Sequence
 represents a sequence number More...
 
typedef SimpleTag< uint64_t, 10 > IncomingFaceIdTag
 
typedef SimpleTag< uint64_t, 11 > NextHopFaceIdTag
 
typedef SimpleTag< CachePolicy, 12 > CachePolicyTag
 
typedef SimpleTag< uint64_t, 13 > CongestionMarkTag
 
typedef SimpleTag< uint64_t, 0x60000000 > HopCountTag
 

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

std::ostream & operator<< (std::ostream &os, CachePolicyType policy)
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (CachePolicy)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (CachePolicy)
 
std::ostream & operator<< (std::ostream &os, NackReason reason)
 
bool isLessSevere (lp::NackReason x, lp::NackReason y)
 compare NackReason for severity More...
 
 NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS (NackHeader)
 
 NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS (NackHeader)
 

Variables

 Field< SequenceField >
 
 Field< FragIndexField >
 
 Field< FragCountField >
 
 Field< NackField >
 
 Field< NextHopFaceIdField >
 
 Field< CachePolicyField >
 
 Field< IncomingFaceIdField >
 
 Field< CongestionMarkField >
 
 Field< AckField >
 
 Field< TxSequenceField >
 
 Field< HopCountTagField >
 
 Field< FragmentField >
 

Typedef Documentation

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

The value of the wire encoded field is the data between the provided iterators.

During encoding, the data is copied from the Buffer into the wire buffer.

Definition at line 98 of file fields.hpp.

typedef uint64_t ndn::lp::Sequence

represents a sequence number

Definition at line 35 of file sequence.hpp.

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

Definition at line 36 of file tags.hpp.

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

Definition at line 43 of file tags.hpp.

Definition at line 50 of file tags.hpp.

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

Definition at line 57 of file tags.hpp.

typedef SimpleTag<uint64_t, 0x60000000> ndn::lp::HopCountTag

Definition at line 64 of file tags.hpp.

Enumeration Type Documentation

indicates the cache policy applied to a Data packet

Enumerator
NONE 
NO_CACHE 

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

enum ndn::lp::NackReason
strong

indicates the reason type of a network NACK

Enumerator
NONE 
CONGESTION 
DUPLICATE 
NO_ROUTE 

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

Function Documentation

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

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

References NO_CACHE.

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

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

References CONGESTION, DUPLICATE, and NO_ROUTE.

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 50 of file nack-header.cpp.

References NONE.

Referenced by nfd::fw::ProcessNackTraitsBase::processNack(), and ndn::PendingInterest::recordNack().

ndn::lp::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS ( NackHeader  )
ndn::lp::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS ( NackHeader  )

Variable Documentation

Definition at line 39 of file fields.hpp.

Definition at line 44 of file fields.hpp.

Definition at line 49 of file fields.hpp.

Definition at line 54 of file fields.hpp.

Definition at line 59 of file fields.hpp.

Definition at line 64 of file fields.hpp.

Definition at line 69 of file fields.hpp.

Definition at line 74 of file fields.hpp.

Definition at line 80 of file fields.hpp.

Definition at line 85 of file fields.hpp.

Definition at line 90 of file fields.hpp.

Definition at line 99 of file fields.hpp.