Namespaces
	asf

Classes
class	AccessStrategy
	Access Router Strategy version 1. More...

class	AdmitAllUnsolicitedDataPolicy
	admits all unsolicited Data More...

class	AdmitLocalUnsolicitedDataPolicy
	admits unsolicited Data from local faces More...

class	AdmitNetworkUnsolicitedDataPolicy
	admits unsolicited Data from non-local faces More...

class	BestRouteStrategy
	Best Route strategy version 1. More...

class	BestRouteStrategy2
	Best Route strategy version 4. More...

class	ClientControlStrategy
	identical to BestRouteStrategy v1, for backwards compatibility More...

class	DropAllUnsolicitedDataPolicy
	drops all unsolicited Data More...

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

class	NccStrategy
	a forwarding strategy similar to CCNx 0.7.2 More...

class	RetxSuppression
	helper for consumer retransmission suppression More...

class	RetxSuppressionExponential
	a retransmission suppression decision algorithm that suppresses retransmissions using exponential backoff More...

class	RetxSuppressionFixed
	a retransmission suppression decision algorithm that suppresses retransmissions within a fixed duration More...

class	Strategy
	represents a forwarding strategy More...

class	StrategyInfo
	contains arbitrary information forwarding strategy places on table entries More...

class	UnsolicitedDataPolicy
	determines how to process an unsolicited Data More...

Typedefs
typedef std::function< unique_ptr< Strategy >Forwarder &)>	StrategyCreateFunc

typedef DropAllUnsolicitedDataPolicy	DefaultUnsolicitedDataPolicy
	the default UnsolicitedDataPolicy More...

Enumerations
enum	DuplicateNonceWhere { DUPLICATE_NONCE_NONE = 0, DUPLICATE_NONCE_IN_SAME = (1 << 0), DUPLICATE_NONCE_IN_OTHER = (1 << 1), DUPLICATE_NONCE_OUT_SAME = (1 << 2), DUPLICATE_NONCE_OUT_OTHER = (1 << 3) }
	indicates where duplicate Nonces are found More...

enum	UnsolicitedDataDecision { UnsolicitedDataDecision::DROP, UnsolicitedDataDecision::CACHE }
	a decision made by UnsolicitedDataPolicy More...

Functions
	NFD_REGISTER_STRATEGY (AccessStrategy)

bool	wouldViolateScope (const Face &inFace, const Interest &interest, const Face &outFace)
	determine whether forwarding the Interest in `pitEntry` to `outFace` would violate scope More...

bool	violatesScope (const pit::Entry &pitEntry, const Face &outFace)

bool	canForwardToLegacy (const pit::Entry &pitEntry, const Face &face)
	decide whether Interest can be forwarded to face More...

int	findDuplicateNonce (const pit::Entry &pitEntry, uint32_t nonce, const Face &face)
	determine whether `pitEntry` has duplicate Nonce `nonce` More...

bool	hasPendingOutRecords (const pit::Entry &pitEntry)
	determine whether `pitEntry` has any pending out-records More...

	DEPRECATED (bool violatesScope(const pit::Entry &pitEntry, const Face &outFace))
	determine whether forwarding the Interest in `pitEntry` to `outFace` would violate scope More...

	NFD_REGISTER_STRATEGY (BestRouteStrategy)

	NFD_REGISTER_STRATEGY (BestRouteStrategy2)

static bool	isNextHopEligible (const Face &inFace, const Interest &interest, const fib::NextHop &nexthop, const shared_ptr< pit::Entry > &pitEntry, bool wantUnused=false, time::steady_clock::TimePoint now=time::steady_clock::TimePoint::min())
	determines whether a NextHop is eligible More...

static fib::NextHopList::const_iterator	findEligibleNextHopWithEarliestOutRecord (const Face &inFace, const Interest &interest, const fib::NextHopList &nexthops, const shared_ptr< pit::Entry > &pitEntry)
	pick an eligible NextHop with earliest out-record More...

lp::NackReason	compareLessSevere (lp::NackReason x, lp::NackReason y)

	NFD_REGISTER_STRATEGY (ClientControlStrategy)

	NFD_REGISTER_STRATEGY (MulticastStrategy)

	NFD_REGISTER_STRATEGY (NccStrategy)

unique_ptr< Strategy >	makeDefaultStrategy (Forwarder &forwarder)

static std::map< Name, StrategyCreateFunc > &	getStrategyFactories ()

void	registerStrategyImpl (const Name &strategyName, const StrategyCreateFunc &createFunc)

void	installStrategies (Forwarder &forwarder)

template<typename S >
void	registerStrategy ()
	registers a strategy to be installed later More...

std::ostream &	operator<< (std::ostream &os, UnsolicitedDataDecision d)

Variables
	AccessStrategy

	BestRouteStrategy2

	ClientControlStrategy

	Strategy

	DropAllUnsolicitedDataPolicy

drop	all

	AdmitLocalUnsolicitedDataPolicy

admit	local

	AdmitNetworkUnsolicitedDataPolicy

admit	network

	AdmitAllUnsolicitedDataPolicy

Typedef Documentation

◆ StrategyCreateFunc

typedef std::function<unique_ptr<Strategy>Forwarder&)> nfd::fw::StrategyCreateFunc

Definition at line 46 of file strategy-registry.hpp.

◆ DefaultUnsolicitedDataPolicy

typedef DropAllUnsolicitedDataPolicy nfd::fw::DefaultUnsolicitedDataPolicy

the default UnsolicitedDataPolicy

Definition at line 119 of file unsolicited-data-policy.hpp.

Enumeration Type Documentation

◆ DuplicateNonceWhere

enum nfd::fw::DuplicateNonceWhere

indicates where duplicate Nonces are found

Enumerator
DUPLICATE_NONCE_NONE	no duplicate Nonce is found
DUPLICATE_NONCE_IN_SAME	in-record of same face
DUPLICATE_NONCE_IN_OTHER	in-record of other face
DUPLICATE_NONCE_OUT_SAME	out-record of same face
DUPLICATE_NONCE_OUT_OTHER	out-record of other face

Definition at line 99 of file algorithm.hpp.

◆ UnsolicitedDataDecision

enum nfd::fw::UnsolicitedDataDecision

strong

a decision made by UnsolicitedDataPolicy

Enumerator
DROP	the Data should be dropped
CACHE	the Data should be cached in the ContentStore

Definition at line 36 of file unsolicited-data-policy.hpp.

Function Documentation

◆ NFD_REGISTER_STRATEGY() [1/6]

nfd::fw::NFD_REGISTER_STRATEGY ( AccessStrategy )

◆ wouldViolateScope()

bool nfd::fw::wouldViolateScope	(	const Face &	inFace,
		const Interest &	interest,
		const Face &	outFace
	)

determine whether forwarding the Interest in pitEntry to outFace would violate scope

See also: https://redmine.named-data.net/projects/nfd/wiki/ScopeControl

Definition at line 37 of file algorithm.cpp.

References ndn::nfd::FACE_SCOPE_LOCAL, ndn::Interest::getName(), nfd::face::Face::getScope(), nfd::scope_prefix::LOCALHOP, and nfd::scope_prefix::LOCALHOST.

Referenced by nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy::afterReceiveInterest(), nfd::fw::AccessStrategy::afterReceiveInterest(), nfd::fw::NccStrategy::doPropagate(), and isNextHopEligible().

◆ violatesScope()

bool nfd::fw::violatesScope	(	const pit::Entry &	pitEntry,
		const Face &	outFace
	)

Definition at line 59 of file algorithm.cpp.

References ndn::nfd::FACE_SCOPE_LOCAL, ndn::nfd::FACE_SCOPE_NON_LOCAL, nfd::pit::Entry::getName(), nfd::face::Face::getScope(), nfd::pit::Entry::in_begin(), nfd::pit::Entry::in_end(), nfd::scope_prefix::LOCALHOP, and nfd::scope_prefix::LOCALHOST.

Referenced by nfd::fw::Strategy::afterReceiveNack().

◆ canForwardToLegacy()

bool nfd::fw::canForwardToLegacy	(	const pit::Entry &	pitEntry,
		const Face &	face
	)

decide whether Interest can be forwarded to face

Returns: true if out-record of this face does not exist or has expired, and there is an in-record not of this face

Note: This algorithm has a weakness that it does not permit consumer retransmissions before out-record expires. Therefore, it's not recommended to use this function in new strategies.

Todo:: find a better name for this function

Definition at line 82 of file algorithm.cpp.

References nfd::pit::Entry::in_begin(), nfd::pit::Entry::in_end(), ndn::time::steady_clock::now(), nfd::pit::Entry::out_begin(), and nfd::pit::Entry::out_end().

Referenced by nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy::afterReceiveInterest(), and nfd::fw::NccStrategy::doPropagate().

◆ findDuplicateNonce()

int nfd::fw::findDuplicateNonce	(	const pit::Entry &	pitEntry,
		uint32_t	nonce,
		const Face &	face
	)

determine whether pitEntry has duplicate Nonce nonce

Returns: OR'ed DuplicateNonceWhere

Definition at line 106 of file algorithm.cpp.

References DUPLICATE_NONCE_IN_OTHER, DUPLICATE_NONCE_IN_SAME, DUPLICATE_NONCE_NONE, DUPLICATE_NONCE_OUT_OTHER, DUPLICATE_NONCE_OUT_SAME, nfd::pit::Entry::getInRecords(), and nfd::pit::Entry::getOutRecords().

Referenced by nfd::Forwarder::startProcessNack().

◆ hasPendingOutRecords()

bool nfd::fw::hasPendingOutRecords ( const pit::Entry & pitEntry )

determine whether pitEntry has any pending out-records

Returns: true if there is at least one out-record waiting for Data

Definition at line 136 of file algorithm.cpp.

References ndn::time::steady_clock::now(), nfd::pit::Entry::out_begin(), and nfd::pit::Entry::out_end().

Referenced by nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy::afterReceiveInterest(), nfd::fw::RetxSuppressionFixed::decide(), nfd::fw::RetxSuppressionExponential::decide(), and nfd::Forwarder::startProcessNack().

◆ DEPRECATED()

nfd::fw::DEPRECATED ( bool violatesScopeconst pit::Entry &pitEntry, const Face &outFace )

determine whether forwarding the Interest in pitEntry to outFace would violate scope

See also: https://redmine.named-data.net/projects/nfd/wiki/ScopeControl

Deprecated:: use violatesScope(inFace, interest, outFace) instead

◆ NFD_REGISTER_STRATEGY() [2/6]

nfd::fw::NFD_REGISTER_STRATEGY ( BestRouteStrategy )

◆ NFD_REGISTER_STRATEGY() [3/6]

nfd::fw::NFD_REGISTER_STRATEGY ( BestRouteStrategy2 )

◆ isNextHopEligible()

static bool nfd::fw::isNextHopEligible	(	const Face &	inFace,
		const Interest &	interest,
		const fib::NextHop &	nexthop,
		const shared_ptr< pit::Entry > &	pitEntry,
		bool	wantUnused = `false`,
		time::steady_clock::TimePoint	now = `time::steady_clock::TimePoint::min()`
	)

inlinestatic

determines whether a NextHop is eligible

Parameters

inFace	incoming face of current Interest
interest	incoming Interest
nexthop	next hop
pitEntry	PIT entry
wantUnused	if true, NextHop must not have unexpired out-record
now	time::steady_clock::now(), ignored if !wantUnused

Definition at line 58 of file best-route-strategy2.cpp.

References nfd::fib::NextHop::getFace(), and wouldViolateScope().

Referenced by nfd::fw::BestRouteStrategy2::afterReceiveInterest(), and findEligibleNextHopWithEarliestOutRecord().

◆ findEligibleNextHopWithEarliestOutRecord()

static fib::NextHopList::const_iterator nfd::fw::findEligibleNextHopWithEarliestOutRecord	(	const Face &	inFace,
		const Interest &	interest,
		const fib::NextHopList &	nexthops,
		const shared_ptr< pit::Entry > &	pitEntry
	)