nlsr::NameLsa Class Reference

Data abstraction for NameLsa NameLsa := NAME-LSA-TYPE TLV-LENGTH Lsa Name+. More...

#include <name-lsa.hpp>

+ Inheritance diagram for nlsr::NameLsa:
+ Collaboration diagram for nlsr::NameLsa:

Public Types

enum  Type {
  Type::ADJACENCY,
  Type::COORDINATE,
  Type::NAME,
  Type::BASE
}
 

Public Member Functions

 NameLsa ()=default
 
 NameLsa (const ndn::Name &originRouter, uint64_t seqNo, const ndn::time::system_clock::TimePoint &timepoint, const NamePrefixList &npl)
 
 NameLsa (const ndn::Block &block)
 
void addName (const ndn::Name &name)
 
const ndn::time::system_clock::TimePoint & getExpirationTimePoint () const
 
ndn::scheduler::EventId getExpiringEventId () const
 
NamePrefixListgetNpl ()
 
const NamePrefixListgetNpl () const
 
const ndn::Name & getOriginRouter () const
 
ndn::Name getOriginRouterCopy () const
 
uint64_t getSeqNo () const
 
Lsa::Type getType () const override
 
bool isEqualContent (const NameLsa &other) const
 
void removeName (const ndn::Name &name)
 
void setExpirationTimePoint (const ndn::time::system_clock::TimePoint &lt)
 
void setExpiringEventId (ndn::scheduler::EventId eid)
 
void setSeqNo (uint64_t seqNo)
 
std::string toString () const override
 
void wireDecode (const ndn::Block &wire)
 
template<ndn::encoding::Tag TAG>
size_t wireEncode (ndn::EncodingImpl< TAG > &block) const
 
const ndn::Block & wireEncode () const override
 

Static Public Member Functions

static constexpr Lsa::Type type ()
 

Protected Attributes

ndn::time::system_clock::TimePoint m_expirationTimePoint
 
ndn::scheduler::EventId m_expiringEventId
 
ndn::Name m_originRouter
 
uint64_t m_seqNo = 0
 
ndn::Block m_wire
 

Detailed Description

Data abstraction for NameLsa NameLsa := NAME-LSA-TYPE TLV-LENGTH Lsa Name+.

Definition at line 35 of file name-lsa.hpp.

Member Enumeration Documentation

◆ Type

enum nlsr::Lsa::Type
stronginherited
Enumerator
ADJACENCY 
COORDINATE 
NAME 
BASE 

Definition at line 55 of file lsa.hpp.

Constructor & Destructor Documentation

◆ NameLsa() [1/3]

nlsr::NameLsa::NameLsa ( )
default

◆ NameLsa() [2/3]

nlsr::NameLsa::NameLsa ( const ndn::Name &  originRouter,
uint64_t  seqNo,
const ndn::time::system_clock::TimePoint &  timepoint,
const NamePrefixList npl 
)

Definition at line 27 of file name-lsa.cpp.

+ Here is the call graph for this function:

◆ NameLsa() [3/3]

nlsr::NameLsa::NameLsa ( const ndn::Block &  block)

Definition at line 37 of file name-lsa.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ addName()

void nlsr::NameLsa::addName ( const ndn::Name &  name)
inline

Definition at line 71 of file name-lsa.hpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getExpirationTimePoint()

const ndn::time::system_clock::TimePoint& nlsr::Lsa::getExpirationTimePoint ( ) const
inlineinherited

Definition at line 101 of file lsa.hpp.

+ Here is the caller graph for this function:

◆ getExpiringEventId()

ndn::scheduler::EventId nlsr::Lsa::getExpiringEventId ( ) const
inlineinherited

Definition at line 120 of file lsa.hpp.

+ Here is the call graph for this function:

◆ getNpl() [1/2]

NamePrefixList& nlsr::NameLsa::getNpl ( )
inline

Definition at line 59 of file name-lsa.hpp.

+ Here is the caller graph for this function:

◆ getNpl() [2/2]

const NamePrefixList& nlsr::NameLsa::getNpl ( ) const
inline

Definition at line 65 of file name-lsa.hpp.

◆ getOriginRouter()

const ndn::Name& nlsr::Lsa::getOriginRouter ( ) const
inlineinherited

Definition at line 89 of file lsa.hpp.

+ Here is the caller graph for this function:

◆ getOriginRouterCopy()

ndn::Name nlsr::Lsa::getOriginRouterCopy ( ) const
inlineinherited

Definition at line 95 of file lsa.hpp.

◆ getSeqNo()

uint64_t nlsr::Lsa::getSeqNo ( ) const
inlineinherited

Definition at line 83 of file lsa.hpp.

+ Here is the caller graph for this function:

◆ getType()

Lsa::Type nlsr::NameLsa::getType ( ) const
inlineoverridevirtual

Implements nlsr::Lsa.

Definition at line 47 of file name-lsa.hpp.

+ Here is the call graph for this function:

◆ isEqualContent()

bool nlsr::NameLsa::isEqualContent ( const NameLsa other) const

Definition at line 119 of file name-lsa.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ removeName()

void nlsr::NameLsa::removeName ( const ndn::Name &  name)
inline

Definition at line 78 of file name-lsa.hpp.

+ Here is the call graph for this function:

◆ setExpirationTimePoint()

void nlsr::Lsa::setExpirationTimePoint ( const ndn::time::system_clock::TimePoint &  lt)
inlineinherited

Definition at line 107 of file lsa.hpp.

◆ setExpiringEventId()

void nlsr::Lsa::setExpiringEventId ( ndn::scheduler::EventId  eid)
inlineinherited

Definition at line 114 of file lsa.hpp.

◆ setSeqNo()

void nlsr::Lsa::setSeqNo ( uint64_t  seqNo)
inlineinherited

Definition at line 76 of file lsa.hpp.

◆ toString()

std::string nlsr::NameLsa::toString ( ) const
overridevirtual

Get data common to all LSA types.

Reimplemented from nlsr::Lsa.

Definition at line 125 of file name-lsa.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ type()

static constexpr Lsa::Type nlsr::NameLsa::type ( )
inlinestatic

Definition at line 53 of file name-lsa.hpp.

+ Here is the caller graph for this function:

◆ wireDecode()

void nlsr::NameLsa::wireDecode ( const ndn::Block &  wire)

Definition at line 83 of file name-lsa.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ wireEncode() [1/2]

template<ndn::encoding::Tag TAG>
size_t nlsr::NameLsa::wireEncode ( ndn::EncodingImpl< TAG > &  block) const

Definition at line 44 of file name-lsa.cpp.

+ Here is the call graph for this function:

◆ wireEncode() [2/2]

const ndn::Block & nlsr::NameLsa::wireEncode ( ) const
overridevirtual

Implements nlsr::Lsa.

Definition at line 65 of file name-lsa.cpp.

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_expirationTimePoint

ndn::time::system_clock::TimePoint nlsr::Lsa::m_expirationTimePoint
protectedinherited

Definition at line 144 of file lsa.hpp.

◆ m_expiringEventId

ndn::scheduler::EventId nlsr::Lsa::m_expiringEventId
protectedinherited

Definition at line 145 of file lsa.hpp.

◆ m_originRouter

ndn::Name nlsr::Lsa::m_originRouter
protectedinherited

Definition at line 142 of file lsa.hpp.

◆ m_seqNo

uint64_t nlsr::Lsa::m_seqNo = 0
protectedinherited

Definition at line 143 of file lsa.hpp.

◆ m_wire

ndn::Block nlsr::Lsa::m_wire
mutableprotectedinherited

Definition at line 147 of file lsa.hpp.