Best Route strategy version 1. More...

#include <best-route-strategy.hpp>

Inheritance diagram for nfd::fw::BestRouteStrategy:

Collaboration diagram for nfd::fw::BestRouteStrategy:

Public Member Functions
	BestRouteStrategy (Forwarder &forwarder, const Name &name=STRATEGY_NAME)

virtual void	afterReceiveInterest (const Face &inFace, const Interest &interest, const shared_ptr< pit::Entry > &pitEntry) override
	trigger after Interest is received More...

const Name &	getName () const

virtual void	beforeSatisfyInterest (const shared_ptr< pit::Entry > &pitEntry, const Face &inFace, const Data &data)
	trigger before PIT entry is satisfied More...

virtual void	beforeExpirePendingInterest (const shared_ptr< pit::Entry > &pitEntry)
	trigger before PIT entry expires More...

virtual void	afterReceiveNack (const Face &inFace, const lp::Nack &nack, const shared_ptr< pit::Entry > &pitEntry)
	trigger after Nack is received More...

Static Public Attributes
static const Name	STRATEGY_NAME

Protected Member Functions
void	sendInterest (const shared_ptr< pit::Entry > &pitEntry, Face &outFace, bool wantNewNonce=false)
	send Interest to outFace More...

void	rejectPendingInterest (const shared_ptr< pit::Entry > &pitEntry)
	decide that a pending Interest cannot be forwarded More...

void	sendNack (const shared_ptr< pit::Entry > &pitEntry, const Face &outFace, const lp::NackHeader &header)
	send Nack to outFace More...

void	sendNacks (const shared_ptr< pit::Entry > &pitEntry, const lp::NackHeader &header, std::initializer_list< const Face * > exceptFaces=std::initializer_list< const Face * >())
	send Nack to every face that has an in-record, except those in `exceptFaces` More...

const fib::Entry &	lookupFib (const pit::Entry &pitEntry) const
	performs a FIB lookup, considering Link object if present More...

MeasurementsAccessor &	getMeasurements ()

Face *	getFace (FaceId id) const

const FaceTable &	getFaceTable () const

Protected Attributes
signal::Signal< FaceTable, Face & > &	afterAddFace

signal::Signal< FaceTable, Face & > &	beforeRemoveFace

Detailed Description

Best Route strategy version 1.

This strategy forwards a new Interest to the lowest-cost nexthop that is not same as the downstream, and does not violate scope. Subsequent similar Interests or consumer retransmissions are suppressed until after InterestLifetime expiry.

Deprecated:: This strategy is superceded by Best Route strategy version 2, which allows consumer retransmissions. This version is kept for comparison purposes and is not recommended for general usage.

Definition at line 45 of file best-route-strategy.hpp.

Constructor & Destructor Documentation

nfd::fw::BestRouteStrategy::BestRouteStrategy	(	Forwarder &	forwarder,
		const Name &	name = `STRATEGY_NAME`
	)

explicit

Definition at line 35 of file best-route-strategy.cpp.

Member Function Documentation

void nfd::fw::BestRouteStrategy::afterReceiveInterest	(	const Face &	inFace,
		const Interest &	interest,
		const shared_ptr< pit::Entry > &	pitEntry
	)

overridevirtual

trigger after Interest is received

The Interest:

does not violate Scope
is not looped
cannot be satisfied by ContentStore
is under a namespace managed by this strategy

The strategy should decide whether and where to forward this Interest.

If the strategy decides to forward this Interest, invoke this->sendInterest one or more times, either now or shortly after
If strategy concludes that this Interest cannot be forwarded, invoke this->rejectPendingInterest so that PIT entry will be deleted shortly

Warning: The strategy must not retain shared_ptr<pit::Entry>, otherwise undefined behavior may occur. However, the strategy is allowed to store weak_ptr<pit::Entry>.

Implements nfd::fw::Strategy.

Reimplemented in nfd::fw::ClientControlStrategy.

Definition at line 41 of file best-route-strategy.cpp.

void nfd::fw::Strategy::afterReceiveNack	(	const Face &	inFace,
		const lp::Nack &	nack,
		const shared_ptr< pit::Entry > &	pitEntry
	)

virtualinherited

trigger after Nack is received

This trigger is invoked when an incoming Nack is received in response to an forwarded Interest. The Nack has been confirmed to be a response to the last Interest forwarded to that upstream, i.e. the PIT out-record exists and has a matching Nonce. The NackHeader has been recorded in the PIT out-record.

In this base class this method does nothing.

Warning: The strategy must not retain shared_ptr<pit::Entry>, otherwise undefined behavior may occur. However, the strategy is allowed to store weak_ptr<pit::Entry>.

Reimplemented in nfd::fw::BestRouteStrategy2, and nfd::fw::asf::AsfStrategy.

Definition at line 61 of file strategy.cpp.

void nfd::fw::Strategy::beforeExpirePendingInterest ( const shared_ptr< pit::Entry > & pitEntry )

virtualinherited

trigger before PIT entry expires

PIT entry expires when InterestLifetime has elapsed for all InRecords, and it is not satisfied by an incoming Data.

This trigger is not invoked for PIT entry already satisfied.

In this base class this method does nothing.

Warning: The strategy must not retain shared_ptr<pit::Entry>, otherwise undefined behavior may occur. However, the strategy is allowed to store weak_ptr<pit::Entry>, although this isn't useful here because PIT entry would be deleted shortly after.

Definition at line 55 of file strategy.cpp.

void nfd::fw::Strategy::beforeSatisfyInterest	(	const shared_ptr< pit::Entry > &	pitEntry,
		const Face &	inFace,
		const Data &	data
	)

virtualinherited

trigger before PIT entry is satisfied

This trigger is invoked when an incoming Data satisfies the PIT entry. It can be invoked even if the PIT entry has already been satisfied.

In this base class this method does nothing.

Warning: The strategy must not retain shared_ptr<pit::Entry>, otherwise undefined behavior may occur. However, the strategy is allowed to store weak_ptr<pit::Entry>.

Reimplemented in nfd::fw::AccessStrategy, nfd::fw::asf::AsfStrategy, and nfd::fw::NccStrategy.

Definition at line 47 of file strategy.cpp.

Face* nfd::fw::Strategy::getFace ( FaceId id ) const

inlineprotectedinherited

Definition at line 194 of file strategy.hpp.

const FaceTable& nfd::fw::Strategy::getFaceTable ( ) const

inlineprotectedinherited

Definition at line 200 of file strategy.hpp.

MeasurementsAccessor& nfd::fw::Strategy::getMeasurements ( )

inlineprotectedinherited

Definition at line 188 of file strategy.hpp.

const Name& nfd::fw::Strategy::getName ( ) const

inlineinherited

Returns: a Name that represents the strategy program

Definition at line 56 of file strategy.hpp.

const fib::Entry & nfd::fw::Strategy::lookupFib ( const pit::Entry & pitEntry ) const

protectedinherited

performs a FIB lookup, considering Link object if present

Todo:: Don't modify in-record Interests. Set SelectedDelegation in outgoing Interest pipeline.

Definition at line 91 of file strategy.cpp.

void nfd::fw::Strategy::rejectPendingInterest ( const shared_ptr< pit::Entry > & pitEntry )

inlineprotectedinherited

decide that a pending Interest cannot be forwarded

Parameters

pitEntry PIT entry

This shall not be called if the pending Interest has been forwarded earlier, and does not need to be resent now.

Definition at line 151 of file strategy.hpp.

void nfd::fw::Strategy::sendInterest	(	const shared_ptr< pit::Entry > &	pitEntry,
		Face &	outFace,
		bool	wantNewNonce = `false`
	)

inlineprotectedinherited

send Interest to outFace

Parameters

pitEntry	PIT entry
outFace	face through which to send out the Interest
wantNewNonce	if true, a new Nonce will be generated, rather than reusing a Nonce from one of the PIT in-records

Definition at line 138 of file strategy.hpp.

void nfd::fw::Strategy::sendNack	(	const shared_ptr< pit::Entry > &	pitEntry,
		const Face &	outFace,
		const lp::NackHeader &	header
	)

inlineprotectedinherited

send Nack to outFace

Parameters

pitEntry	PIT entry
outFace	face through which to send out the Nack
header	Nack header

The outFace must have a PIT in-record, otherwise this method has no effect.

Definition at line 164 of file strategy.hpp.

void nfd::fw::Strategy::sendNacks	(	const shared_ptr< pit::Entry > &	pitEntry,
		const lp::NackHeader &	header,
		std::initializer_list< const Face * >	exceptFaces = `std::initializer_list<const Face*>()`
	)

protectedinherited

send Nack to every face that has an in-record, except those in exceptFaces

Parameters

pitEntry	PIT entry
header	NACK header
exceptFaces	list of faces that should be excluded from sending Nacks

Note: This is not an action, but a helper that invokes the sendNack action.

Definition at line 69 of file strategy.cpp.

Member Data Documentation

signal::Signal<FaceTable, Face&>& nfd::fw::Strategy::afterAddFace

protectedinherited

Definition at line 206 of file strategy.hpp.

signal::Signal<FaceTable, Face&>& nfd::fw::Strategy::beforeRemoveFace

protectedinherited

Definition at line 207 of file strategy.hpp.

const Name nfd::fw::BestRouteStrategy::STRATEGY_NAME

static

Definition at line 56 of file best-route-strategy.hpp.

NFD - Named Data Networking Forwarding Daemon 0.5.0 documentation

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation