a forwarding strategy that forwards Interest to all FIB nexthops More...

#include <multicast-strategy.hpp>

Inheritance diagram for nfd::fw::MulticastStrategy:

Collaboration diagram for nfd::fw::MulticastStrategy:

Public Member Functions
	MulticastStrategy (Forwarder &forwarder, const Name &name=getStrategyName())

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

const Name &	getInstanceName () 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 Member Functions
static const Name &	getStrategyName ()

template<typename S >
static void	registerType (const Name &strategyName=S::getStrategyName())
	register a strategy type More...

static bool	canCreate (const Name &instanceName)

static unique_ptr< Strategy >	create (const Name &instanceName, Forwarder &forwarder)

static bool	areSameType (const Name &instanceNameA, const Name &instanceNameB)

static std::set< Name >	listRegistered ()

Protected Member Functions
void	sendInterest (const shared_ptr< pit::Entry > &pitEntry, Face &outFace, const Interest &interest)
	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

void	setInstanceName (const Name &name)
	set strategy instance name More...

Static Protected Member Functions
static ParsedInstanceName	parseInstanceName (const Name &input)
	parse a strategy instance name More...

static Name	makeInstanceName (const Name &input, const Name &strategyName)
	construct a strategy instance name More...

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

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

Detailed Description

a forwarding strategy that forwards Interest to all FIB nexthops

Definition at line 36 of file multicast-strategy.hpp.

Constructor & Destructor Documentation

nfd::fw::MulticastStrategy::MulticastStrategy	(	Forwarder &	forwarder,
		const Name &	name = `getStrategyName()`
	)

Definition at line 34 of file multicast-strategy.cpp.

Member Function Documentation

void nfd::fw::MulticastStrategy::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.

Definition at line 56 of file multicast-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 166 of file strategy.cpp.

bool nfd::fw::Strategy::areSameType	(	const Name &	instanceNameA,
		const Name &	instanceNameB
	)

staticinherited

Returns: whether instanceNameA and instanceNameA will initiate same strategy type

Definition at line 106 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 160 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 152 of file strategy.cpp.

bool nfd::fw::Strategy::canCreate ( const Name & instanceName )

staticinherited

Returns: whether a strategy instance can be created from instanceName

Parameters

instanceName strategy instance name, may contain version and parameters

Note: This function finds a strategy type using same rules as create , but does not attempt to construct an instance.

Definition at line 84 of file strategy.cpp.

unique_ptr< Strategy > nfd::fw::Strategy::create	(	const Name &	instanceName,
		Forwarder &	forwarder
	)

staticinherited

Returns: a strategy instance created from instanceName

Return values

nullptr if !canCreate(instanceName)

Exceptions

std::invalid_argument strategy type constructor does not accept specified version or parameters

Definition at line 90 of file strategy.cpp.

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

inlineprotectedinherited

Definition at line 247 of file strategy.hpp.

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

inlineprotectedinherited

Definition at line 253 of file strategy.hpp.

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

inlineinherited

Returns: strategy instance name

The instance name is assigned during instantiation. It contains a version component, and may have extra parameter components.

Definition at line 110 of file strategy.hpp.

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

inlineprotectedinherited

Definition at line 241 of file strategy.hpp.

const Name & nfd::fw::MulticastStrategy::getStrategyName ( )

static

Definition at line 49 of file multicast-strategy.cpp.

std::set< Name > nfd::fw::Strategy::listRegistered ( )

staticinherited

Returns: registered versioned strategy names

Definition at line 112 of file strategy.cpp.

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 196 of file strategy.cpp.

Name nfd::fw::Strategy::makeInstanceName	(	const Name &	input,
		const Name &	strategyName
	)

staticprotectedinherited

construct a strategy instance name

Parameters

input	strategy instance name, may contain version and parameters
strategyName	strategy name with version but without parameters; typically this should be `getStrategyName()`

If input contains a version component, return input unchanged. Otherwise, return input plus the version component taken from strategyName. This allows a strategy instance to be constructed with an unversioned name, but its final instance name should contain the version.

Definition at line 132 of file strategy.cpp.

Strategy::ParsedInstanceName nfd::fw::Strategy::parseInstanceName ( const Name & input )

staticprotectedinherited

parse a strategy instance name

Parameters

input strategy instance name, may contain version and parameters

Exceptions

std::invalid_argument input format is unacceptable

Definition at line 121 of file strategy.cpp.

template<typename S >

static void nfd::fw::Strategy::registerType ( const Name & strategyName = S::getStrategyName() )

inlinestaticinherited

register a strategy type

Template Parameters

S	subclass of Strategy

Parameters

strategyName strategy program name, must contain version

Note: It is permitted to register the same strategy type under multiple names, which is useful in tests and for creating aliases.

Definition at line 48 of file strategy.hpp.

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 204 of file strategy.hpp.

void nfd::fw::Strategy::sendInterest	(	const shared_ptr< pit::Entry > &	pitEntry,
		Face &	outFace,
		const Interest &	interest
	)

inlineprotectedinherited

send Interest to outFace

Parameters

pitEntry	PIT entry
outFace	face through which to send out the Interest
interest	the Interest packet

Definition at line 191 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 217 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 174 of file strategy.cpp.

void nfd::fw::Strategy::setInstanceName ( const Name & name )

inlineprotectedinherited

set strategy instance name

Note: This must be called by strategy subclass constructor.

Definition at line 290 of file strategy.hpp.

Member Data Documentation

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

protectedinherited

Definition at line 306 of file strategy.hpp.

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

protectedinherited

Definition at line 307 of file strategy.hpp.

NFD - Named Data Networking Forwarding Daemon 0.5.1 documentation

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation