ndn::nfd::Route Class Reference

Data abstraction for Route. More...

#include <nfd-rib-entry.hpp>

Inheritance diagram for ndn::nfd::Route:

Collaboration diagram for ndn::nfd::Route:

Classes
class	Error

Public Member Functions
	Route ()
	Route (const Block &block)
uint64_t	getFaceId () const
Route &	setFaceId (uint64_t faceId)
uint64_t	getOrigin () const
Route &	setOrigin (uint64_t origin)
	set Origin More...
uint64_t	getCost () const
Route &	setCost (uint64_t cost)
uint64_t	getFlags () const
Route &	setFlags (uint64_t flags)
	set route inheritance flags More...
const time::milliseconds &	getExpirationPeriod () const
Route &	setExpirationPeriod (const time::milliseconds &expirationPeriod)
bool	hasInfiniteExpirationPeriod () const
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &block) const
const Block &	wireEncode () const
void	wireDecode (const Block &wire)
Public Member Functions inherited from ndn::nfd::RibFlagsTraits< Route >
bool	isChildInherit () const
bool	isRibCapture () const

Static Public Attributes
static const time::milliseconds	INFINITE_EXPIRATION_PERIOD

Detailed Description

Data abstraction for Route.

A route indicates the availability of content via a certain face and provides meta-information about the face.

Route := ROUTE-TYPE TLV-LENGTH
           FaceId
           Origin
           Cost
           Flags
           ExpirationPeriod?

See also

http://redmine.named-data.net/projects/nfd/wiki/RibMgmt

Definition at line 51 of file nfd-rib-entry.hpp.

Constructor & Destructor Documentation

Route() [1/2]

ndn::nfd::Route::Route

(

)

Definition at line 44 of file nfd-rib-entry.cpp.

Referenced by ndn::nfd::Route::Error::Error(), and ndn::nfd::RibEntry::wireDecode().

Route() [2/2]

ndn::nfd::Route::Route ( const Block &  block )

explicit

Definition at line 54 of file nfd-rib-entry.cpp.

References wireDecode().

Member Function Documentation

getFaceId()

uint64_t ndn::nfd::Route::getFaceId ( ) const

inline

Definition at line 69 of file nfd-rib-entry.hpp.

Referenced by ndn::nfd::operator<<().

setFaceId()

Route& ndn::nfd::Route::setFaceId ( uint64_t  faceId )

inline

Definition at line 75 of file nfd-rib-entry.hpp.

Referenced by nfd::rib::RibStatusPublisher::generate().

getOrigin()

uint64_t ndn::nfd::Route::getOrigin ( ) const

inline

Definition at line 83 of file nfd-rib-entry.hpp.

Referenced by ndn::nfd::operator<<().

setOrigin()

Route& ndn::nfd::Route::setOrigin ( uint64_t  origin )

inline

set Origin

Parameters

origin

a code defined in ndn::nfd::RouteOrigin

Definition at line 92 of file nfd-rib-entry.hpp.

Referenced by nfd::rib::RibStatusPublisher::generate().

getCost()

uint64_t ndn::nfd::Route::getCost ( ) const

inline

Definition at line 100 of file nfd-rib-entry.hpp.

Referenced by ndn::nfd::operator<<().

setCost()

Route& ndn::nfd::Route::setCost ( uint64_t  cost )

inline

Definition at line 106 of file nfd-rib-entry.hpp.

Referenced by nfd::rib::RibStatusPublisher::generate().

getFlags()

uint64_t ndn::nfd::Route::getFlags ( ) const

inline

Definition at line 114 of file nfd-rib-entry.hpp.

Referenced by ndn::nfd::operator<<().

setFlags()

Route& ndn::nfd::Route::setFlags ( uint64_t  flags )

inline

set route inheritance flags

Parameters

flags

a bitwise OR'ed code from ndn::nfd::RouteFlags

Definition at line 123 of file nfd-rib-entry.hpp.

Referenced by nfd::rib::RibStatusPublisher::generate().

getExpirationPeriod()

const time::milliseconds& ndn::nfd::Route::getExpirationPeriod ( ) const

inline

Definition at line 133 of file nfd-rib-entry.hpp.

Referenced by ndn::nfd::operator<<().

setExpirationPeriod()

Route& ndn::nfd::Route::setExpirationPeriod ( const time::milliseconds &  expirationPeriod )

inline

Definition at line 139 of file nfd-rib-entry.hpp.

References INFINITE_EXPIRATION_PERIOD.

Referenced by nfd::rib::RibStatusPublisher::generate().

hasInfiniteExpirationPeriod()

bool ndn::nfd::Route::hasInfiniteExpirationPeriod ( ) const

inline

Definition at line 150 of file nfd-rib-entry.hpp.

References ndn::nfd::operator<<(), wireDecode(), and wireEncode().

Referenced by ndn::nfd::operator<<().

wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::nfd::Route::wireEncode

(

EncodingImpl< TAG > &

block

)

const

Definition at line 61 of file nfd-rib-entry.cpp.

References ndn::tlv::nfd::Cost, ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::Flags, ndn::tlv::nfd::Origin, ndn::encoding::prependNonNegativeIntegerBlock(), and ndn::tlv::nfd::Route.

wireEncode() [2/2]

const Block & ndn::nfd::Route::wireEncode

(

)

const

Definition at line 101 of file nfd-rib-entry.cpp.

References ndn::Block::hasWire().

Referenced by ndn::nfd::RibEntry::clearRoutes(), hasInfiniteExpirationPeriod(), and ndn::nfd::RibEntry::wireEncode().

wireDecode()

void ndn::nfd::Route::wireDecode

(

const Block &

wire

)

Definition at line 119 of file nfd-rib-entry.cpp.

References ndn::tlv::nfd::Cost, ndn::Block::elements_begin(), ndn::Block::elements_end(), ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::Flags, INFINITE_EXPIRATION_PERIOD, ndn::tlv::nfd::Origin, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::nfd::Route, and ndn::Block::type().

Referenced by ndn::nfd::RibEntry::clearRoutes(), hasInfiniteExpirationPeriod(), ndn::nfd::RibEntry::RibEntry(), and Route().

Member Data Documentation

INFINITE_EXPIRATION_PERIOD

const time::milliseconds ndn::nfd::Route::INFINITE_EXPIRATION_PERIOD

static

Definition at line 130 of file nfd-rib-entry.hpp.

Referenced by setExpirationPeriod(), and wireDecode().

---

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

• ndnSIM/ndn-cxx/src/management/nfd-rib-entry.hpp
• ndnSIM/ndn-cxx/src/management/nfd-rib-entry.cpp