a forwarding strategy similar to CCNx 0.7.2 More...

#include <ncc-strategy.hpp>

Inheritance diagram for nfd::fw::NccStrategy:

Collaboration diagram for nfd::fw::NccStrategy:

[legend]

Classes
class	MeasurementsEntryInfo
	StrategyInfo on measurements::Entry. More...

class	PitEntryInfo
	StrategyInfo on pit::Entry. More...

Public Member Functions
	NccStrategy (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	beforeSatisfyInterest (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data) override
	trigger before PIT entry is satisfied 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	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	afterReceiveNack (const FaceEndpoint &ingress, const lp::Nack &nack, const shared_ptr< pit::Entry > &pitEntry)
	trigger after Nack 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 ()

Protected Member Functions
MeasurementsEntryInfo &	getMeasurementsEntryInfo (measurements::Entry *entry)

MeasurementsEntryInfo &	getMeasurementsEntryInfo (const shared_ptr< pit::Entry > &entry)

void	doPropagate (FaceId inFaceId, weak_ptr< pit::Entry > pitEntryWeak)
	propagate to another upstream More...

void	timeoutOnBestFace (weak_ptr< pit::Entry > pitEntryWeak)
	best face did not reply within prediction More...

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...

Static Protected Attributes
static const time::microseconds	DEFER_FIRST_WITHOUT_BEST_FACE = 4_ms

static const time::microseconds	DEFER_RANGE_WITHOUT_BEST_FACE = 75_ms

static const int	UPDATE_MEASUREMENTS_N_LEVELS = 2

static const time::nanoseconds	MEASUREMENTS_LIFETIME = 16_s

Additional Inherited Members
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 similar to CCNx 0.7.2

Note: This strategy is not EndpointId-aware.

Definition at line 38 of file ncc-strategy.hpp.

Constructor & Destructor Documentation

◆ NccStrategy()

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

explicit

Definition at line 41 of file ncc-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::NccStrategy::getStrategyName ( )

static

Definition at line 56 of file ncc-strategy.cpp.

Referenced by NccStrategy().

◆ afterReceiveInterest()

void nfd::fw::NccStrategy::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 63 of file ncc-strategy.cpp.

References nfd::fw::NccStrategy::PitEntryInfo::bestFaceTimeout, nfd::fw::canForwardToLegacy(), DEFER_FIRST_WITHOUT_BEST_FACE, DEFER_RANGE_WITHOUT_BEST_FACE, doPropagate(), nfd::FaceEndpoint::face, nfd::fw::NccStrategy::MeasurementsEntryInfo::getBestFace(), nfd::face::Face::getId(), getMeasurementsEntryInfo(), nfd::fib::Entry::getNextHops(), nfd::getScheduler(), nfd::fib::Entry::hasNextHop(), nfd::fw::hasPendingOutRecords(), nfd::fw::Strategy::lookupFib(), nfd::fw::NccStrategy::PitEntryInfo::maxInterval, nfd::fw::NccStrategy::MeasurementsEntryInfo::prediction, nfd::fw::NccStrategy::MeasurementsEntryInfo::previousFace, nfd::fw::NccStrategy::PitEntryInfo::propagateTimer, nfd::fw::Strategy::rejectPendingInterest(), nfd::fw::Strategy::sendInterest(), timeoutOnBestFace(), and nfd::fw::wouldViolateScope().

◆ beforeSatisfyInterest()

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

overridevirtual

trigger before PIT entry is satisfied

This trigger is invoked when an incoming Data satisfies more than one PIT entry. The strategy can collect measurements information, but cannot manipulate Data forwarding. When an incoming Data satisfies only one PIT entry, afterReceiveData is invoked instead and given full control over Data forwarding. If a strategy does not override afterReceiveData, the default implementation invokes beforeSatisfyInterest.

Normally, PIT entries would be erased after receiving the first matching Data. 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 Data 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 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 from nfd::fw::Strategy.

Definition at line 210 of file ncc-strategy.cpp.

References nfd::fw::NccStrategy::PitEntryInfo::bestFaceTimeout, ndn::detail::CancelHandle::cancel(), nfd::measurements::MeasurementsAccessor::extendLifetime(), nfd::FaceEndpoint::face, nfd::measurements::MeasurementsAccessor::get(), nfd::fw::NccStrategy::MeasurementsEntryInfo::getBestFace(), nfd::fw::Strategy::getMeasurements(), getMeasurementsEntryInfo(), nfd::measurements::MeasurementsAccessor::getParent(), MEASUREMENTS_LIFETIME, nfd::fw::NccStrategy::PitEntryInfo::propagateTimer, UPDATE_MEASUREMENTS_N_LEVELS, and nfd::fw::NccStrategy::MeasurementsEntryInfo::updateBestFace().