nfd::rib::Route Class Reference

represents a route for a name prefix More...

#include <route.hpp>

Inheritance diagram for nfd::rib::Route:

Collaboration diagram for nfd::rib::Route:

Public Member Functions
	Route ()=default
	default constructor More...
	Route (const ndn::PrefixAnnouncement &ann, uint64_t faceId)
	construct from a prefix announcement More...
const ndn::util::scheduler::EventId &	getExpirationEvent () const
void	setExpirationEvent (const ndn::util::scheduler::EventId &eid)
void	cancelExpirationEvent ()
std::underlying_type< ndn::nfd::RouteFlags >::type	getFlags () const
Public Member Functions inherited from ndn::nfd::RouteFlagsTraits< Route >
bool	isChildInherit () const
bool	isRibCapture () const

Public Attributes
uint64_t	faceId = 0
ndn::nfd::RouteOrigin	origin = ndn::nfd::ROUTE_ORIGIN_APP
uint64_t	cost = 0
std::underlying_type< ndn::nfd::RouteFlags >::type	flags = ndn::nfd::ROUTE_FLAGS_NONE
optional< time::steady_clock::TimePoint >	expires
optional< ndn::PrefixAnnouncement >	announcement
	The prefix announcement that caused the creation of this route. More...
time::steady_clock::TimePoint	annExpires
	Expiration time of the prefix announcement. More...

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

Detailed Description

represents a route for a name prefix

Definition at line 43 of file route.hpp.

Constructor & Destructor Documentation

Route() [1/2]

nfd::rib::Route::Route ( )

default

default constructor

Route() [2/2]

nfd::rib::Route::Route	(	const ndn::PrefixAnnouncement &	ann,
		uint64_t	faceId
	)

construct from a prefix announcement

Parameters

ann	a prefix announcement that has passed verification
faceId	the face on which ann arrived

Definition at line 51 of file route.cpp.

Member Function Documentation

getExpirationEvent()

const ndn::util::scheduler::EventId& nfd::rib::Route::getExpirationEvent ( ) const

inline

Definition at line 57 of file route.hpp.

setExpirationEvent()

void nfd::rib::Route::setExpirationEvent ( const ndn::util::scheduler::EventId &  eid )

inline

Definition at line 63 of file route.hpp.

cancelExpirationEvent()

void nfd::rib::Route::cancelExpirationEvent ( )

inline

Definition at line 69 of file route.hpp.

References ndn::detail::CancelHandle::cancel().

getFlags()

std::underlying_type<ndn::nfd::RouteFlags>::type nfd::rib::Route::getFlags ( ) const

inline

Definition at line 75 of file route.hpp.

References flags.

Member Data Documentation

faceId

uint64_t nfd::rib::Route::faceId = 0

Definition at line 81 of file route.hpp.

Referenced by nfd::rib::RibUpdateBatch::add(), nfd::rib::compareFaceId(), nfd::rib::compareFaceIdAndOrigin(), nfd::rib::RibEntry::findInheritedRoute(), nfd::rib::Rib::insert(), nfd::rib::operator<<(), nfd::rib::operator==(), nfd::rib::RibEntry::removeInheritedRoute(), nfd::rib::RibManager::slRenew(), and nfd::rib::sortRoutes().

origin

ndn::nfd::RouteOrigin nfd::rib::Route::origin = ndn::nfd::ROUTE_ORIGIN_APP

Definition at line 82 of file route.hpp.

Referenced by nfd::rib::compareFaceIdAndOrigin(), nfd::rib::operator<<(), nfd::rib::operator==(), and nfd::rib::RibManager::slRenew().

cost

uint64_t nfd::rib::Route::cost = 0

Definition at line 83 of file route.hpp.

Referenced by nfd::rib::RibEntry::getRouteWithLowestCostAndChildInheritByFaceId(), nfd::rib::RibEntry::getRouteWithLowestCostByFaceId(), nfd::rib::RibEntry::getRouteWithSecondLowestCostByFaceId(), nfd::rib::operator<<(), and nfd::rib::operator==().

flags

std::underlying_type<ndn::nfd::RouteFlags>::type nfd::rib::Route::flags = ndn::nfd::ROUTE_FLAGS_NONE

Definition at line 84 of file route.hpp.

Referenced by getFlags(), nfd::rib::RibEntry::insertRoute(), nfd::rib::operator<<(), and nfd::rib::operator==().

expires

optional<time::steady_clock::TimePoint> nfd::rib::Route::expires

Definition at line 85 of file route.hpp.

Referenced by nfd::rib::RibEntry::getPrefixAnnouncement(), nfd::rib::operator<<(), nfd::rib::operator==(), nfd::rib::RibManager::slAnnounce(), and nfd::rib::RibManager::slRenew().

announcement

optional<ndn::PrefixAnnouncement> nfd::rib::Route::announcement

The prefix announcement that caused the creation of this route.

This is nullopt if this route is not created by a prefix announcement.

Definition at line 91 of file route.hpp.

Referenced by nfd::rib::RibEntry::getPrefixAnnouncement(), nfd::rib::operator<<(), nfd::rib::operator==(), and nfd::rib::RibManager::slRenew().

annExpires

time::steady_clock::TimePoint nfd::rib::Route::annExpires

Expiration time of the prefix announcement.

Valid only if announcement is not nullopt.

If this field is before or equal the current time, it indicates the prefix announcement is not yet valid or has expired. In this case, the exact value of this field does not matter. If this field is after the current time, it indicates when the prefix announcement expires.

Definition at line 101 of file route.hpp.

Referenced by nfd::rib::RibManager::slAnnounce(), and nfd::rib::RibManager::slRenew().

---

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

• ndnSIM/NFD/rib/route.hpp
• ndnSIM/NFD/rib/route.cpp