nlsr::NameLsa Class Reference

Represents an LSA of name prefixes announced by the origin router. More...

#include <name-lsa.hpp>

Inheritance diagram for nlsr::NameLsa:

Collaboration diagram for nlsr::NameLsa:

Public Types
enum class	Type {   ADJACENCY ,   COORDINATE ,   NAME ,   BASE }

Public Member Functions
	NameLsa ()=default
	NameLsa (const ndn::Block &block)
	NameLsa (const ndn::Name &originRouter, uint64_t seqNo, const ndn::time::system_clock::time_point &timepoint, const NamePrefixList &npl)
void	addName (const ndn::Name &name)
const ndn::time::system_clock::time_point &	getExpirationTimePoint () const
NamePrefixList &	getNpl ()
const NamePrefixList &	getNpl () const
const ndn::Name &	getOriginRouter () const
uint64_t	getSeqNo () const
Lsa::Type	getType () const override
void	removeName (const ndn::Name &name)
void	setExpirationTimePoint (const ndn::time::system_clock::time_point &lt)
void	setExpiringEventId (ndn::scheduler::EventId eid)
void	setSeqNo (uint64_t seqNo)
std::tuple< bool, std::list< ndn::Name >, std::list< ndn::Name > >	update (const std::shared_ptr< Lsa > &lsa) override
void	wireDecode (const ndn::Block &wire)
const ndn::Block &	wireEncode () const override
template<ndn::encoding::Tag TAG>
size_t	wireEncode (ndn::EncodingImpl< TAG > &block) const

Static Public Member Functions
static constexpr Lsa::Type	type ()

Protected Attributes
ndn::time::system_clock::time_point	m_expirationTimePoint
ndn::scheduler::ScopedEventId	m_expiringEventId
ndn::Name	m_originRouter
uint64_t	m_seqNo = 0
ndn::Block	m_wire

Friends
bool	operator== (const NameLsa &lhs, const NameLsa &rhs)

Detailed Description

Represents an LSA of name prefixes announced by the origin router.

NameLsa is encoded as:

NameLsa = NAME-LSA-TYPE TLV-LENGTH
            Lsa
            1*Name

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

Member Enumeration Documentation

Type

enum nlsr::Lsa::Type

stronginherited

Enumerator
ADJACENCY
COORDINATE
NAME
BASE

Definition at line 54 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::time_point &	timepoint,
		const NamePrefixList &	npl
	)

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

NameLsa() [3/3]

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

explicit

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

Member Function Documentation

addName()

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

inline

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

getExpirationTimePoint()

const ndn::time::system_clock::time_point& nlsr::Lsa::getExpirationTimePoint ( ) const

inlineinherited

Definition at line 97 of file lsa.hpp.

getNpl() [1/2]

NamePrefixList& nlsr::NameLsa::getNpl ( )

inline

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

getNpl() [2/2]

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

inline

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

getOriginRouter()

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

inlineinherited

Definition at line 91 of file lsa.hpp.

getSeqNo()

uint64_t nlsr::Lsa::getSeqNo ( ) const

inlineinherited

Definition at line 85 of file lsa.hpp.

getType()

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

inlineoverridevirtual

Implements nlsr::Lsa.

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

removeName()

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

inline

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

setExpirationTimePoint()

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

inlineinherited

Definition at line 103 of file lsa.hpp.

setExpiringEventId()

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

inlineinherited

Definition at line 110 of file lsa.hpp.

setSeqNo()

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

inlineinherited

Definition at line 78 of file lsa.hpp.

type()

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

inlinestaticconstexpr

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

update()

std::tuple< bool, std::list< ndn::Name >, std::list< ndn::Name > > nlsr::NameLsa::update ( const std::shared_ptr< Lsa > &  lsa )

overridevirtual

Implements nlsr::Lsa.

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

wireDecode()

void nlsr::NameLsa::wireDecode

(

const ndn::Block &

wire

)

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

wireEncode() [1/2]

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

overridevirtual

Implements nlsr::Lsa.

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

wireEncode() [2/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.

Friends And Related Function Documentation

operator==

bool operator== ( const NameLsa &  lhs, const NameLsa &  rhs  )

friend

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

Member Data Documentation

m_expirationTimePoint

ndn::time::system_clock::time_point nlsr::Lsa::m_expirationTimePoint

protectedinherited

Definition at line 139 of file lsa.hpp.

m_expiringEventId

ndn::scheduler::ScopedEventId nlsr::Lsa::m_expiringEventId

protectedinherited

Definition at line 140 of file lsa.hpp.

m_originRouter

ndn::Name nlsr::Lsa::m_originRouter

protectedinherited

Definition at line 137 of file lsa.hpp.

m_seqNo

uint64_t nlsr::Lsa::m_seqNo = 0

protectedinherited

Definition at line 138 of file lsa.hpp.

m_wire

ndn::Block nlsr::Lsa::m_wire

mutableprotectedinherited

Definition at line 142 of file lsa.hpp.