NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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
 
RoutesetFaceId (uint64_t faceId)
 
RouteOrigin getOrigin () const
 
RoutesetOrigin (RouteOrigin origin)
 
uint64_t getCost () const
 
RoutesetCost (uint64_t cost)
 
uint64_t getFlags () const
 
RoutesetFlags (uint64_t flags)
 
bool hasExpirationPeriod () const
 
time::milliseconds getExpirationPeriod () const
 
RoutesetExpirationPeriod (time::milliseconds expirationPeriod)
 
RouteunsetExpirationPeriod ()
 
template<encoding::Tag TAG>
size_t wireEncode (EncodingImpl< TAG > &block) const
 
const BlockwireEncode () 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 37 of file rib-entry.cpp.

◆ Route() [2/2]

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

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

References wireDecode().

Member Function Documentation

◆ getFaceId()

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

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

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

◆ setFaceId()

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

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

References ndn::Block::reset().

◆ getOrigin()

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

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

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

◆ setOrigin()

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

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

References ndn::Block::reset().

◆ getCost()

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

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

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

◆ setCost()

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

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

References ndn::Block::reset().

◆ getFlags()

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

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

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

◆ setFlags()

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

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

References ndn::Block::reset().

◆ hasExpirationPeriod()

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

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

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

◆ getExpirationPeriod()

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

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

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

◆ setExpirationPeriod()

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

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

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

◆ unsetExpirationPeriod()

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

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

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

Referenced by setExpirationPeriod().

◆ wireEncode() [1/2]

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

◆ wireEncode() [2/2]

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

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

References ndn::Block::hasWire().

◆ wireDecode()


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