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

#include <multicast-strategy.hpp>

Inheritance diagram for nfd::fw::MulticastStrategy:

[legend]

Collaboration diagram for nfd::fw::MulticastStrategy:

[legend]

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

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

void	afterReceiveNack (const FaceEndpoint &ingress, const lp::Nack &nack, const shared_ptr< pit::Entry > &pitEntry) override
	trigger after Nack is received More...

Public Member Functions inherited from nfd::fw::Strategy
	Strategy (Forwarder &forwarder)
	Construct a strategy instance. More...

virtual	~Strategy ()

const Name &	getInstanceName () const

bool	wantNewNextHopTrigger () const

virtual void	afterReceiveLoopedInterest (const FaceEndpoint &ingress, const Interest &interest, pit::Entry &pitEntry)
	trigger after a looped Interest is received More...

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

virtual void	afterContentStoreHit (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data)
	trigger after a Data is matched in CS More...

virtual void	afterReceiveData (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data)
	trigger after Data is received More...

virtual void	onDroppedInterest (const FaceEndpoint &egress, const Interest &interest)
	trigger after Interest dropped for exceeding allowed retransmissions More...

virtual void	afterNewNextHop (const fib::NextHop &nextHop, const shared_ptr< pit::Entry > &pitEntry)
	trigger after new nexthop is added More...

Static Public Member Functions
static const Name &	getStrategyName ()

Static Public Member Functions inherited from nfd::fw::Strategy
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 ()

static const Name &	getStrategyName ()

Additional Inherited Members
Protected Member Functions inherited from nfd::fw::Strategy
void	sendInterest (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &egress, const Interest &interest)
	send Interest to egress More...

void	sendData (const shared_ptr< pit::Entry > &pitEntry, const Data &data, const FaceEndpoint &egress)
	send `data` to `egress` More...

void	sendDataToAll (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data)
	send `data` to all matched and qualified face-endpoint pairs More...

void	rejectPendingInterest (const shared_ptr< pit::Entry > &pitEntry)
	schedule the PIT entry for immediate deletion More...

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

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

void	setExpiryTimer (const shared_ptr< pit::Entry > &pitEntry, time::milliseconds duration)
	Schedule the PIT entry to be erased after `duration`. 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...

void	enableNewNextHopTrigger (bool enabled)
	set whether the afterNewNextHop trigger should be invoked for this strategy More...

Protected Member Functions inherited from nfd::fw::ProcessNackTraits< MulticastStrategy >
	ProcessNackTraits (MulticastStrategy *strategy)

Protected Member Functions inherited from nfd::fw::ProcessNackTraitsBase
virtual	~ProcessNackTraitsBase ()=default

void	processNack (const Face &inFace, const lp::Nack &nack, const shared_ptr< pit::Entry > &pitEntry)

Static Protected Member Functions inherited from nfd::fw::Strategy
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 inherited from nfd::fw::Strategy
signal::Signal< FaceTable, Face > &	afterAddFace

signal::Signal< FaceTable, Face > &	beforeRemoveFace

Detailed Description

a forwarding strategy that forwards Interest to all FIB nexthops

Note: This strategy is not EndpointId-aware.

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

Constructor & Destructor Documentation

◆ MulticastStrategy()

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

explicit

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

References getStrategyName(), nfd::fw::Strategy::makeInstanceName(), NDN_THROW, nfd::fw::Strategy::ParsedInstanceName::parameters, nfd::fw::Strategy::parseInstanceName(), nfd::fw::Strategy::setInstanceName(), ndn::to_string(), and nfd::fw::Strategy::ParsedInstanceName::version.

Member Function Documentation

◆ getStrategyName()

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

static

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

Referenced by MulticastStrategy().

◆ afterReceiveInterest()

void nfd::fw::MulticastStrategy::afterReceiveInterest	(	const FaceEndpoint &	ingress,
		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 PIT entry is set to expire after InterestLifetime has elapsed at each downstream.

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

If the strategy decides to forward this Interest, invoke sendInterest for each upstream, either now or shortly after via a scheduler event, but before PIT entry expires. Optionally, the strategy can invoke setExpiryTimer to adjust how long it would wait for a response.
If the strategy has already forwarded this Interest previously and decides to continue waiting, do nothing. Optionally, the strategy can invoke setExpiryTimer to adjust how long it would wait for a response.
If the strategy concludes that this Interest cannot be satisfied, invoke rejectPendingInterest to erase the PIT entry.

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

References nfd::fw::RetxSuppressionExponential::decidePerUpstream(), nfd::FaceEndpoint::face, nfd::fw::FORWARD, nfd::face::Face::getId(), nfd::face::Face::getLinkType(), nfd::fib::Entry::getNextHops(), nfd::fw::RetxSuppressionExponential::incrementIntervalForOutRecord(), ndn::nfd::LINK_TYPE_AD_HOC, nfd::fw::Strategy::lookupFib(), NFD_LOG_DEBUG, nfd::fw::Strategy::rejectPendingInterest(), nfd::fw::Strategy::sendInterest(), nfd::fw::Strategy::sendNack(), ndn::lp::NackHeader::setReason(), nfd::fw::SUPPRESS, and nfd::fw::wouldViolateScope().

◆ afterReceiveNack()

void nfd::fw::MulticastStrategy::afterReceiveNack	(	const FaceEndpoint &	ingress,
		const lp::Nack &	nack,
		const shared_ptr< pit::Entry > &	pitEntry
	)

overridevirtual

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.

If the PIT entry is not yet satisfied, its expiry timer remains unchanged. Otherwise, the PIT entry normally would expire immediately after this function returns.

If the strategy wishes to collect responses from additional upstream nodes, it should invoke setExpiryTimer within this function to retain the PIT entry. If a Nack arrives from another upstream during the extended PIT entry lifetime, this trigger will be invoked again. At that time, this function must invoke setExpiryTimer again to continue collecting more responses.

In the 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 from nfd::fw::Strategy.

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

References nfd::FaceEndpoint::face, and nfd::fw::ProcessNackTraitsBase::processNack().

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

ndnSIM/NFD/daemon/fw/multicast-strategy.hpp
ndnSIM/NFD/daemon/fw/multicast-strategy.cpp

Public Member Functions

Static Public Member Functions