Self-learning forwarding strategy. More...

#include <self-learning-strategy.hpp>

Inheritance diagram for nfd::fw::SelfLearningStrategy:

Collaboration diagram for nfd::fw::SelfLearningStrategy:

Classes
class	InRecordInfo
	StrategyInfo on pit::InRecord. More...

class	OutRecordInfo
	StrategyInfo on pit::OutRecord. More...

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

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

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

void	afterReceiveNack (const lp::Nack &nack, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
	Trigger after a 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

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

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

virtual void	satisfyInterest (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data, std::set< std::pair< Face , EndpointId >> &satisfiedDownstreams, std::set< std::pair< Face , EndpointId >> &unsatisfiedDownstreams)

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

virtual void	onDroppedInterest (const Interest &interest, Face &egress)
	Trigger after an Interest is dropped (e.g., for exceeding allowed retransmissions). More...

virtual void	afterNewNextHop (const fib::NextHop &nextHop, const shared_ptr< pit::Entry > &pitEntry)
	Trigger after a 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
NFD_VIRTUAL_WITH_TESTS pit::OutRecord *	sendInterest (const Interest &interest, Face &egress, const shared_ptr< pit::Entry > &pitEntry)
	Send an Interest packet. More...

NFD_VIRTUAL_WITH_TESTS bool	sendData (const Data &data, Face &egress, const shared_ptr< pit::Entry > &pitEntry)
	Send a Data packet. More...

NFD_VIRTUAL_WITH_TESTS void	sendDataToAll (const Data &data, const shared_ptr< pit::Entry > &pitEntry, const Face &inFace)
	Send a Data packet to all matched and qualified faces. More...

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

NFD_VIRTUAL_WITH_TESTS bool	sendNack (const lp::NackHeader &header, Face &egress, const shared_ptr< pit::Entry > &pitEntry)
	Send a Nack packet. More...

void	sendNacks (const lp::NackHeader &header, const shared_ptr< pit::Entry > &pitEntry, std::initializer_list< const Face *> exceptFaces={})
	Send Nack to every face that has an in-record, except those in `exceptFaces`. 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...

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

Self-learning forwarding strategy.

This strategy first broadcasts Interest to learn a single path towards data, then unicasts subsequent Interests along the learned path.

See also: https://redmine.named-data.net/attachments/864/Self-learning-strategy-v1.pdf

Definition at line 43 of file self-learning-strategy.hpp.

Constructor & Destructor Documentation

◆ SelfLearningStrategy()

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

explicit

Definition at line 47 of file self-learning-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::SelfLearningStrategy::getStrategyName ( )

static

Definition at line 62 of file self-learning-strategy.cpp.

References ns3::ndn::Name.

Referenced by SelfLearningStrategy().

◆ afterReceiveInterest()

void nfd::fw::SelfLearningStrategy::afterReceiveInterest	(	const Interest &	interest,
		const FaceEndpoint &	ingress,
		const shared_ptr< pit::Entry > &	pitEntry
	)

overridevirtual

Trigger after an Interest is received.

The Interest:

has not exceeded HopLimit
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 the 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 a copy of the pitEntry shared_ptr after this function returns, otherwise undefined behavior may occur. However, the strategy is allowed to construct and keep a weak_ptr to pitEntry.

Implements nfd::fw::Strategy.

Definition at line 69 of file self-learning-strategy.cpp.

References nfd::FaceEndpoint::face, nfd::fib::Entry::getNextHops(), ndn::TagHost::getTag(), nfd::fw::Strategy::lookupFib(), NFD_LOG_DEBUG, nfd::fw::Strategy::rejectPendingInterest(), nfd::fw::Strategy::sendNack(), ndn::lp::NackHeader::setReason(), and ndn::TagHost::setTag().

◆ afterReceiveData()

void nfd::fw::SelfLearningStrategy::afterReceiveData	(	const Data &	data,
		const FaceEndpoint &	ingress,
		const shared_ptr< pit::Entry > &	pitEntry
	)

overridevirtual

trigger after Data is received

This trigger is invoked when an incoming Data satisfies exactly one PIT entry, and gives the strategy full control over Data forwarding.

When this trigger is invoked:

The Data has been verified to satisfy the PIT entry.
The PIT entry expiry timer is set to now

Inside this function:

A strategy should return Data to downstream nodes via sendData() or sendDataToAll().
A strategy can modify the Data as long as it still satisfies the PIT entry, such as adding or removing congestion marks.
A strategy can delay Data forwarding by prolonging the PIT entry lifetime via setExpiryTimer(), and later forward the Data before the PIT entry is erased.
A strategy can collect measurements about the upstream.
A strategy can collect responses from additional upstream nodes by prolonging the PIT entry lifetime via setExpiryTimer() every time a Data is received. Note that only one Data should be returned to each downstream node.

In the base class, this method invokes beforeSatisfyInterest() and then returns the Data to all downstream faces via sendDataToAll().

Warning: The strategy must not retain a copy of the pitEntry shared_ptr after this function returns, otherwise undefined behavior may occur. However, the strategy is allowed to construct and keep a weak_ptr to pitEntry.

Reimplemented from nfd::fw::Strategy.

Definition at line 103 of file self-learning-strategy.cpp.

References nfd::FaceEndpoint::face, ndn::Data::getName(), ndn::TagHost::getTag(), nfd::fw::SelfLearningStrategy::OutRecordInfo::isNonDiscoveryInterest, NFD_LOG_DEBUG, and nfd::fw::Strategy::sendDataToAll().

◆ afterReceiveNack()

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

overridevirtual

Trigger after a 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 will normally 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 prolong the PIT entry lifetime. If a Nack arrives from another upstream during the extended PIT entry lifetime, this trigger will be invoked again. At that time, the strategy must invoke setExpiryTimer() again to continue collecting more responses.

In the base class, this method does nothing.

Warning: The strategy must not retain a copy of the pitEntry shared_ptr after this function returns, otherwise undefined behavior may occur. However, the strategy is allowed to construct and keep a weak_ptr to pitEntry.

Reimplemented from nfd::fw::Strategy.

Definition at line 133 of file self-learning-strategy.cpp.

References Face, nfd::FaceEndpoint::face, ndn::nfd::FACE_SCOPE_LOCAL, nfd::rib::Service::get(), nfd::fw::Strategy::getFace(), nfd::fw::Strategy::getFaceTable(), ndn::lp::Nack::getHeader(), ndn::lp::Nack::getInterest(), ndn::Data::getName(), ndn::Interest::getName(), ndn::lp::Nack::getReason(), nfd::rib::Service::getRibManager(), nfd::fib::Entry::hasNextHops(), nfd::fw::isNextHopEligible(), nfd::fw::SelfLearningStrategy::InRecordInfo::isNonDiscoveryInterest, nfd::fw::SelfLearningStrategy::OutRecordInfo::isNonDiscoveryInterest, ndn::nfd::LINK_TYPE_AD_HOC, nfd::fw::Strategy::lookupFib(), nonstd::optional_lite::std11::move(), NFD_LOG_DEBUG, ndn::time::steady_clock::now(), nfd::runOnMainIoService(), nfd::runOnRibIoService(), nfd::fw::Strategy::sendDataToAll(), nfd::fw::Strategy::sendInterest(), nfd::fw::Strategy::sendNacks(), nfd::fw::Strategy::setExpiryTimer(), nfd::RibManager::slAnnounce(), nfd::RibManager::slFindAnn(), nfd::RibManager::slRenew(), and nfd::fw::wouldViolateScope().

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

ndnSIM/NFD/daemon/fw/self-learning-strategy.hpp
ndnSIM/NFD/daemon/fw/self-learning-strategy.cpp

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SelfLearningStrategy()

Member Function Documentation

◆ getStrategyName()

◆ afterReceiveInterest()

◆ afterReceiveData()

◆ afterReceiveNack()