NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
ndn::lp::Packet Class Reference

#include <packet.hpp>

Classes

class  Error
 

Public Member Functions

 Packet ()
 
 Packet (const Block &wire)
 
Block wireEncode () const
 encode packet into wire format More...
 
void wireDecode (const Block &wire)
 decode packet from wire format More...
 
NDN_CXX_NODISCARD bool empty () const
 
template<typename FIELD >
NDN_CXX_NODISCARD bool has () const
 
template<typename FIELD >
NDN_CXX_NODISCARD size_t count () const
 
template<typename FIELD >
FIELD::ValueType get (size_t index=0) const
 
template<typename FIELD >
NDN_CXX_NODISCARD std::vector< typename FIELD::ValueType > list () const
 
template<typename FIELD >
Packetset (const typename FIELD::ValueType &value)
 remove all occurrences of FIELD, and add a FIELD with value More...
 
template<typename FIELD >
Packetadd (const typename FIELD::ValueType &value)
 add a FIELD with value More...
 
template<typename FIELD >
Packetremove (size_t index=0)
 remove the index-th occurrence of FIELD More...
 
template<typename FIELD >
Packetclear ()
 remove all occurrences of FIELD More...
 

Detailed Description

Definition at line 30 of file packet.hpp.

Constructor & Destructor Documentation

◆ Packet() [1/2]

ndn::lp::Packet::Packet ( )

Definition at line 108 of file packet.cpp.

◆ Packet() [2/2]

ndn::lp::Packet::Packet ( const Block wire)
explicit

Definition at line 113 of file packet.cpp.

References wireDecode().

Member Function Documentation

◆ wireEncode()

Block ndn::lp::Packet::wireEncode ( ) const

encode packet into wire format

Definition at line 119 of file packet.cpp.

References ndn::Block::elements(), and ndn::Block::encode().

Referenced by nfd::face::LpFragmenter::fragmentPacket(), and nfd::face::LpReliability::piggyback().

◆ wireDecode()

void ndn::lp::Packet::wireDecode ( const Block wire)

decode packet from wire format

Exceptions
Errorunknown TLV-TYPE

Definition at line 133 of file packet.cpp.

References ndn::Block::begin(), ndn::tlv::Data, ndn::Block::elements(), ndn::Block::end(), info, ndn::tlv::Interest, ndn::lp::tlv::LpPacket, NDN_THROW, ndn::Block::parse(), ndn::to_string(), and ndn::Block::type().

Referenced by Packet().

◆ empty()

NDN_CXX_NODISCARD bool ndn::lp::Packet::empty ( ) const
inline
Return values
truepacket has no field
falsepacket has one or more fields

Definition at line 62 of file packet.hpp.

References NDN_CXX_NODISCARD.

◆ has()

template<typename FIELD >
NDN_CXX_NODISCARD bool ndn::lp::Packet::has ( ) const
inline

◆ count()

template<typename FIELD >
NDN_CXX_NODISCARD size_t ndn::lp::Packet::count ( ) const
inline
Returns
number of occurrences of FIELD

Definition at line 84 of file packet.hpp.

Referenced by get(), and remove().

◆ get()

template<typename FIELD >
FIELD::ValueType ndn::lp::Packet::get ( size_t  index = 0) const
inline

◆ list()

template<typename FIELD >
NDN_CXX_NODISCARD std::vector<typename FIELD::ValueType> ndn::lp::Packet::list ( ) const
inline
Returns
values of all occurrences of FIELD

Definition at line 116 of file packet.hpp.

References websocketpp::utf8_validator::decode(), and ndn::Block::elements().

Referenced by nfd::face::LpReliability::processIncomingPacket().

◆ set()

template<typename FIELD >
Packet& ndn::lp::Packet::set ( const typename FIELD::ValueType &  value)
inline

remove all occurrences of FIELD, and add a FIELD with value

This equivalent to clear() followed by add(value)

Definition at line 136 of file packet.hpp.

Referenced by nfd::face::LpFragmenter::fragmentPacket(), and nfd::face::LpReliability::piggyback().

◆ add()

template<typename FIELD >
Packet& ndn::lp::Packet::add ( const typename FIELD::ValueType &  value)
inline

add a FIELD with value

Exceptions
std::invalid_argumentif field already exists and is not repeatable

Definition at line 148 of file packet.hpp.

References ndn::Block::insert(), and NDN_THROW.

Referenced by ndn::addFieldFromTag(), nfd::face::LpFragmenter::fragmentPacket(), nfd::face::LpReliability::piggyback(), ndn::Face::Impl::putNack(), and ndn::util::DummyClientFace::receive().

◆ remove()

template<typename FIELD >
Packet& ndn::lp::Packet::remove ( size_t  index = 0)
inline

remove the index-th occurrence of FIELD

Exceptions
std::out_of_rangeif index>=count()

Definition at line 173 of file packet.hpp.

References count(), and NDN_THROW.

Referenced by clear().

◆ clear()

template<typename FIELD >
Packet& ndn::lp::Packet::clear ( )
inline

remove all occurrences of FIELD

Definition at line 194 of file packet.hpp.

References remove().


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