ndn::nfd::Route Class Reference

represents a route in a RibEntry More...

#include <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)
RouteOrigin	getOrigin () const
Route &	setOrigin (RouteOrigin origin)
uint64_t	getCost () const
Route &	setCost (uint64_t cost)
uint64_t	getFlags () const
Route &	setFlags (uint64_t flags)
bool	hasExpirationPeriod () const
time::milliseconds	getExpirationPeriod () const
Route &	setExpirationPeriod (time::milliseconds expirationPeriod)
Route &	unsetExpirationPeriod ()
template<encoding::Tag TAG>
size_t	wireEncode (EncodingImpl< TAG > &block) const
const Block &	wireEncode () const
void	wireDecode (const Block &block)
Public Member Functions inherited from ndn::nfd::RouteFlagsTraits< Route >
bool	isChildInherit () const
bool	isRibCapture () const

Additional Inherited Members
Protected Member Functions inherited from ndn::nfd::RouteFlagsTraits< Route >
	RouteFlagsTraits ()=default

Detailed Description

represents a route in a RibEntry

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

See also

https://redmine.named-data.net/projects/nfd/wiki/RibMgmt#Route

Definition at line 42 of file rib-entry.hpp.

Constructor & Destructor Documentation

Route() [1/2]

ndn::nfd::Route::Route

(

)

Definition at line 38 of file rib-entry.cpp.

Route() [2/2]

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

explicit

Definition at line 46 of file rib-entry.cpp.

References wireDecode().

Member Function Documentation

getFaceId()

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

inline

Definition at line 57 of file rib-entry.hpp.

References setFaceId().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

setFaceId()

Route & ndn::nfd::Route::setFaceId

(

uint64_t

faceId

)

Definition at line 52 of file rib-entry.cpp.

References ndn::Block::reset().

Referenced by nfd::RibManager::enableLocalFields(), and getFaceId().

getOrigin()

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

inline

Definition at line 66 of file rib-entry.hpp.

References setOrigin().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

setOrigin()

Route & ndn::nfd::Route::setOrigin

(

RouteOrigin

origin

)

Definition at line 60 of file rib-entry.cpp.

References ndn::Block::reset().

Referenced by nfd::RibManager::enableLocalFields(), and getOrigin().

getCost()

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

inline

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

References setCost().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

setCost()

Route & ndn::nfd::Route::setCost

(

uint64_t

cost

)

Definition at line 68 of file rib-entry.cpp.

References ndn::Block::reset().

Referenced by nfd::RibManager::enableLocalFields(), and getCost().

getFlags()

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

inline

Definition at line 84 of file rib-entry.hpp.

References setFlags().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

setFlags()

Route & ndn::nfd::Route::setFlags

(

uint64_t

flags

)

Definition at line 76 of file rib-entry.cpp.

References ndn::Block::reset().

Referenced by nfd::RibManager::enableLocalFields(), and getFlags().

hasExpirationPeriod()

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

inline

Definition at line 93 of file rib-entry.hpp.

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

getExpirationPeriod()

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

inline

Definition at line 99 of file rib-entry.hpp.

References ndn::nfd::NDN_CXX_DECLARE_WIRE_ENCODE_INSTANTIATIONS(), ndn::nfd::operator==(), setExpirationPeriod(), unsetExpirationPeriod(), wireDecode(), and wireEncode().

Referenced by ndn::nfd::operator<<(), and ndn::nfd::operator==().

setExpirationPeriod()

Route & ndn::nfd::Route::setExpirationPeriod

(

time::milliseconds

expirationPeriod

)

Definition at line 84 of file rib-entry.cpp.

References ndn::Block::reset(), and unsetExpirationPeriod().

Referenced by nfd::RibManager::enableLocalFields(), and getExpirationPeriod().

unsetExpirationPeriod()

Route & ndn::nfd::Route::unsetExpirationPeriod

(

)

Definition at line 95 of file rib-entry.cpp.

References nonstd::optional_lite::nullopt, and ndn::Block::reset().

Referenced by getExpirationPeriod(), and setExpirationPeriod().

wireEncode() [1/2]

template<encoding::Tag TAG>

size_t ndn::nfd::Route::wireEncode

(

EncodingImpl< TAG > &

block

)

const

Definition at line 104 of file rib-entry.cpp.

References ndn::tlv::nfd::Cost, ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::Flags, ndn::nfd::NDN_CXX_DEFINE_WIRE_ENCODE_INSTANTIATIONS(), 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 125 of file rib-entry.cpp.

References ndn::Block::hasWire().

Referenced by getExpirationPeriod(), ndn::nfd::RibEntry::setRoutes(), and ndn::nfd::RibEntry::wireEncode().

wireDecode()

void ndn::nfd::Route::wireDecode

(

const Block &

block

)

Definition at line 141 of file 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, NDN_THROW, nonstd::optional_lite::nullopt, ndn::tlv::nfd::Origin, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::nfd::Route, and ndn::Block::type().

Referenced by getExpirationPeriod(), ndn::nfd::RibEntry::RibEntry(), Route(), and ndn::nfd::RibEntry::setRoutes().

---

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

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