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

ndn::nfd::Route::Route

(

)

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

Referenced by ndn::nfd::Route::Error::Error().

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

explicit

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

References wireDecode().

Member Function Documentation

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

inline

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

References setFaceId().

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

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

(

uint64_t

faceId

)

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

References ndn::Block::reset().

Referenced by getFaceId(), and nfd::rib::RibManager::onRibUpdateFailure().

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

inline

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

References setOrigin().

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

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

(

RouteOrigin

origin

)

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

References ndn::Block::reset().

Referenced by getOrigin(), and nfd::rib::RibManager::onRibUpdateFailure().

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

inline

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

References setCost().

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

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

(

uint64_t

cost

)

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

References ndn::Block::reset().

Referenced by getCost(), and nfd::rib::RibManager::onRibUpdateFailure().

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

inline

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

References setFlags().

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

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

(

uint64_t

flags

)

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

References ndn::Block::reset().

Referenced by getFlags(), and nfd::rib::RibManager::onRibUpdateFailure().

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

inline

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

References websocketpp::lib::asio::milliseconds().

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

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

inline

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

References websocketpp::lib::asio::milliseconds(), 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==().

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

(

time::milliseconds

expirationPeriod

)

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

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

Referenced by getExpirationPeriod(), and nfd::rib::RibManager::onRibUpdateFailure().

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

(

)

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

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

Referenced by getExpirationPeriod(), and setExpirationPeriod().

template<encoding::Tag TAG>

size_t ndn::nfd::Route::wireEncode

(

EncodingImpl< TAG > &

block

)

const

Definition at line 103 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.

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

(

)

const

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

References ndn::Block::hasWire().

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

void ndn::nfd::Route::wireDecode

(

const Block &

block

)

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

References ndn::tlv::nfd::Cost, ndn::optional< T >::emplace(), ndn::tlv::nfd::ExpirationPeriod, ndn::tlv::nfd::FaceId, ndn::tlv::nfd::Flags, ndn::nullopt, ndn::tlv::nfd::Origin, ndn::Block::parse(), ndn::encoding::readNonNegativeInteger(), ndn::tlv::nfd::Route, ndn::to_string(), 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/src/mgmt/nfd/rib-entry.hpp
• ndnSIM/ndn-cxx/src/mgmt/nfd/rib-entry.cpp