Data Structures | Public Member Functions | Static Public Attributes
ndn::nfd::Route Class Reference
Management

Data abstraction for Route. More...

#include <rib-entry.hpp>

Inheritance diagram for ndn::nfd::Route:
[legend]
Collaboration diagram for ndn::nfd::Route:
[legend]

Data Structures

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)
 
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 rib-entry.hpp.

Constructor & Destructor Documentation

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

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

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

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

Member Function Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Definition at line 48 of file rib-flags.hpp.

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

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

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

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

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

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

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

set route inheritance flags

Parameters
flagsa bitwise OR'ed code from ndn::nfd::RouteFlags

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

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

set Origin

Parameters
origina code defined in ndn::nfd::RouteOrigin

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

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

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

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

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

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

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

Field Documentation

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

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