NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks 		API Documentation
Classes | Public Member Functions | List of all members
ndn::lp::PrefixAnnouncement Class Reference

represents a Prefix Announcement More...

#include <prefix-announcement.hpp>

Classes

class  Error
 

Public Member Functions

 PrefixAnnouncement ()
 
 PrefixAnnouncement (const Block &block)
 
 PrefixAnnouncement (shared_ptr< const Data > data)
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &encoder) const
 
void wireDecode (const Block &wire)
 
Name getAnnouncedName () const
 Get announced name. More...
 
shared_ptr< const Data > getData () const
 
PrefixAnnouncement & setData (shared_ptr< const Data > data)
 

Detailed Description

represents a Prefix Announcement

This type wraps a Data, and is intended for self-learning. The Name of Data starts with /self-learning prefix, ends with a version component, and the components in the middle refer to the announced name prefix. The MetaInfo and Content of the Data must be empty.

Definition at line 40 of file prefix-announcement.hpp.

Constructor & Destructor Documentation

◆ PrefixAnnouncement() [1/3]

ndn::lp::PrefixAnnouncement::PrefixAnnouncement ( )
default

◆ PrefixAnnouncement() [2/3]

ndn::lp::PrefixAnnouncement::PrefixAnnouncement ( const Block &  block)
explicit

Definition at line 34 of file prefix-announcement.cpp.

References wireDecode().

◆ PrefixAnnouncement() [3/3]

ndn::lp::PrefixAnnouncement::PrefixAnnouncement ( shared_ptr< const Data >  data)
explicit

Definition at line 39 of file prefix-announcement.cpp.

References setData().

Member Function Documentation

◆ wireEncode()

template<encoding::Tag TAG>
size_t ndn::lp::PrefixAnnouncement::wireEncode ( EncodingImpl< TAG > &  encoder) const

Definition at line 46 of file prefix-announcement.cpp.

References ndn::lp::tlv::PrefixAnnouncement.

◆ wireDecode()

void ndn::lp::PrefixAnnouncement::wireDecode ( const Block &  wire)

Definition at line 58 of file prefix-announcement.cpp.

References ndn::tlv::Data, ndn::Block::get(), ndn::Block::parse(), ndn::lp::tlv::PrefixAnnouncement, setData(), ndn::to_string(), and ndn::Block::type().

Referenced by PrefixAnnouncement().

◆ getAnnouncedName()

Name ndn::lp::PrefixAnnouncement::getAnnouncedName ( ) const

Get announced name.

Exceptions
ErrorPrefixAnnouncement is empty

Definition at line 69 of file prefix-announcement.cpp.

References ndn::Name::at(), ndn::Name::getSubName(), ndn::name::Component::isVersion(), ndn::lp::SELF_LEARNING_PREFIX, and ndn::Name::size().

◆ getData()

shared_ptr<const Data> ndn::lp::PrefixAnnouncement::getData ( ) const
inline

Definition at line 75 of file prefix-announcement.hpp.

◆ setData()

PrefixAnnouncement & ndn::lp::PrefixAnnouncement::setData ( shared_ptr< const Data >  data)

Definition at line 83 of file prefix-announcement.cpp.

References ndn::lp::SELF_LEARNING_PREFIX.

Referenced by PrefixAnnouncement(), and wireDecode().

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