Classes | Public Member Functions | List of all members
ndn::nfd::Route Class Reference

Represents a route in a RibEntry. More...

#include <ndn-cxx/mgmt/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 getCost () const
 
time::milliseconds getExpirationPeriod () const
 
uint64_t getFaceId () const
 
uint64_t getFlags () const
 
RouteOrigin getOrigin () const
 
bool hasExpirationPeriod () const
 
bool isChildInherit () const
 
bool isRibCapture () const
 
Route & setCost (uint64_t cost)
 
Route & setExpirationPeriod (time::milliseconds expirationPeriod)
 
Route & setFaceId (uint64_t faceId)
 
Route & setFlags (uint64_t flags)
 
Route & setOrigin (RouteOrigin origin)
 
Route & unsetExpirationPeriod ()
 
void wireDecode (const Block &block)
 
const Block & wireEncode () const
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &block) const
 

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 41 of file rib-entry.hpp.

Constructor & Destructor Documentation

◆ Route() [1/2]

ndn::nfd::Route::Route ( )
default

◆ Route() [2/2]

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

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

Member Function Documentation

◆ getCost()

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

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

◆ getExpirationPeriod()

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

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

◆ getFaceId()

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

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

◆ getFlags()

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

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

◆ getOrigin()

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

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

◆ hasExpirationPeriod()

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

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

◆ isChildInherit()

bool ndn::nfd::RouteFlagsTraits< Route >::isChildInherit ( ) const
inlineinherited

Definition at line 41 of file route-flags-traits.hpp.

◆ isRibCapture()

bool ndn::nfd::RouteFlagsTraits< Route >::isRibCapture ( ) const
inlineinherited

Definition at line 47 of file route-flags-traits.hpp.

◆ setCost()

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

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

◆ setExpirationPeriod()

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

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

◆ setFaceId()

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

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

◆ setFlags()

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

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

◆ setOrigin()

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

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

◆ unsetExpirationPeriod()

Route & ndn::nfd::Route::unsetExpirationPeriod ( )

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

◆ wireDecode()

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

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

◆ wireEncode() [1/2]

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

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

◆ wireEncode() [2/2]

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

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