ndn::Fib Class Reference

Forwarding Information Base. More...

#include <ndn/fib.hpp>

Public Member Functions
Route management
Error	addRoute (const Name &prefix, FaceId faceId, uint8_t cost=0)
	Add a route.
void	removeRoute (const Name &prefix, FaceId faceId)
	Remove a specific next-hop.
void	removeRoute (const Name &prefix)
	Remove all routes for a prefix.
void	removeFace (FaceId faceId)
	Remove a specified Face from all entries.
Lookup
const FibEntry *	findLongestMatch (const Name &name) const
	Look up using Longest Prefix Match.
const FibEntry *	findExact (const Name &prefix) const
	Look up using exact match.
FibEntry *	findExact (const Name &prefix)
	Look up using exact match (non-const version)
Statistics
size_t	size () const
	Get the current number of entries.
size_t	capacity () const
	Get the maximum number of entries.

Detailed Description

Forwarding Information Base.

One of the core components of the forwarder. Determines which Face to forward Interests to. Uses Longest Prefix Match for forwarding lookups.

Fib fib;
 
// Add a route
Name prefix;
prefix.appendComponent("sensor");
fib.addRoute(prefix, espNowFaceId, 10);  // Cost 10
 
// Look up forwarding destination (Longest Prefix Match)
Name interestName;
interestName.appendComponent("sensor");
interestName.appendComponent("temperature");
if (auto* entry = fib.findLongestMatch(interestName)) {
    for (size_t i = 0; i < entry->nexthopCount(); i++) {
        forwardTo(entry->nexthop(i).faceId, interest);
    }
}

Definition at line 119 of file fib.hpp.

Member Function Documentation

addRoute()

Error ndn::Fib::addRoute	(	const Name &	prefix,
		FaceId	faceId,
		uint8_t	cost = 0
	)

Add a route.

Registers a forwarding destination for the specified prefix. If the prefix already exists, adds a next-hop.

Parameters

prefix	Name prefix
faceId	Next-hop Face ID
cost	Cost (default: 0)

Returns

Error::Success on success, Error::Full when table is full

Definition at line 56 of file fib.cpp.

References ndn::FibEntry::addNexthop(), and findExact().

Referenced by ndn::Forwarder::addRoute(), ndn::Forwarder::addRoute(), and ndn::Forwarder::registerPrefix().

capacity()

size_t ndn::Fib::capacity ( ) const

inline

Get the maximum number of entries.

Returns

Maximum number of entries

Definition at line 205 of file fib.hpp.

References ndn::FIB_MAX_ENTRIES.

findExact() [1/2]

FibEntry * ndn::Fib::findExact

(

const Name &

prefix

)

Look up using exact match (non-const version)

Parameters

prefix

Prefix to search for

Returns

Pointer to the entry if found, nullptr otherwise

Definition at line 143 of file fib.cpp.

findExact() [2/2]

const FibEntry * ndn::Fib::findExact

(

const Name &

prefix

)

const

Look up using exact match.

Parameters

prefix

Prefix to search for

Returns

Const pointer to the entry if found, nullptr otherwise

Definition at line 134 of file fib.cpp.

Referenced by addRoute(), removeRoute(), and removeRoute().

findLongestMatch()

const FibEntry * ndn::Fib::findLongestMatch

(

const Name &

name

)

const

Look up using Longest Prefix Match.

Returns the entry with the longest prefix that matches the given Name.

Parameters

name	Name to search for

Returns

Pointer to the entry if found, nullptr otherwise

Definition at line 117 of file fib.cpp.

References ndn::Name::componentCount().

removeFace()

void ndn::Fib::removeFace

(

FaceId

faceId

)

Remove a specified Face from all entries.

Call this when a Face is disconnected.

Parameters

faceId

Face ID to remove

Definition at line 105 of file fib.cpp.

Referenced by ndn::Forwarder::removeFace().

removeRoute() [1/2]

void ndn::Fib::removeRoute

(

const Name &

prefix

)

Remove all routes for a prefix.

Parameters

prefix

Name prefix

Definition at line 96 of file fib.cpp.

References findExact().

removeRoute() [2/2]

void ndn::Fib::removeRoute	(	const Name &	prefix,
		FaceId	faceId
	)

Remove a specific next-hop.

Parameters

prefix	Name prefix
faceId	Face ID to remove

Definition at line 81 of file fib.cpp.

References findExact(), and ndn::FibEntry::removeNexthop().

Referenced by ndn::Forwarder::unregisterPrefix().

size()

size_t ndn::Fib::size ( ) const

inline

Get the current number of entries.

Returns

Number of entries

Definition at line 199 of file fib.hpp.

---

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

• include/ndn/fib.hpp
• src/fib.cpp