nfd::rib::Route Class Reference

Represents a route for a name prefix. More...

#include <daemon/rib/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...
void	cancelExpirationEvent ()
const scheduler::EventId &	getExpirationEvent () const
std::underlying_type_t< ndn::nfd::RouteFlags >	getFlags () const
void	setExpirationEvent (const scheduler::EventId &eid)

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

Detailed Description

Represents a route for a name prefix.

Definition at line 42 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

cancelExpirationEvent()

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

inline

Definition at line 68 of file route.hpp.

getExpirationEvent()

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

inline

Definition at line 56 of file route.hpp.

getFlags()

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

inline

Definition at line 74 of file route.hpp.

setExpirationEvent()

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

inline

Definition at line 62 of file route.hpp.

Member Data Documentation

annExpires

time::steady_clock::time_point 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 100 of file route.hpp.

announcement

std::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 90 of file route.hpp.

cost

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

Definition at line 82 of file route.hpp.

expires

std::optional<time::steady_clock::time_point> nfd::rib::Route::expires

Definition at line 84 of file route.hpp.

faceId

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

Definition at line 80 of file route.hpp.

flags

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

Definition at line 83 of file route.hpp.

origin

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

Definition at line 81 of file route.hpp.