Main class of NFD's forwarding engine. More...

#include <forwarder.hpp>

Collaboration diagram for nfd::Forwarder:

[legend]

Public Member Functions
	Forwarder (FaceTable &faceTable)

NFD_VIRTUAL_WITH_TESTS	~Forwarder ()

const ForwarderCounters &	getCounters () const

fw::UnsolicitedDataPolicy &	getUnsolicitedDataPolicy () const

void	setUnsolicitedDataPolicy (unique_ptr< fw::UnsolicitedDataPolicy > policy)

NameTree &	getNameTree ()

Fib &	getFib ()

Pit &	getPit ()

Cs &	getCs ()

Measurements &	getMeasurements ()

StrategyChoice &	getStrategyChoice ()

DeadNonceList &	getDeadNonceList ()

NetworkRegionTable &	getNetworkRegionTable ()

void	setConfigFile (ConfigFile &configFile)
	register handler for forwarder section of NFD configuration file More...

NFD_VIRTUAL_WITH_TESTS void	onInterestLoop (const Interest &interest, const FaceEndpoint &ingress)
	Interest loop pipeline. More...

NFD_VIRTUAL_WITH_TESTS void	onContentStoreMiss (const Interest &interest, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry)
	Content Store miss pipeline. More...

NFD_VIRTUAL_WITH_TESTS void	onContentStoreHit (const Interest &interest, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry, const Data &data)
	Content Store hit pipeline. More...

NFD_VIRTUAL_WITH_TESTS pit::OutRecord *	onOutgoingInterest (const Interest &interest, Face &egress, const shared_ptr< pit::Entry > &pitEntry)
	outgoing Interest pipeline More...

NFD_VIRTUAL_WITH_TESTS void	onInterestFinalize (const shared_ptr< pit::Entry > &pitEntry)
	Interest finalize pipeline. More...

NFD_VIRTUAL_WITH_TESTS void	onIncomingData (const Data &data, const FaceEndpoint &ingress)
	incoming Data pipeline More...

NFD_VIRTUAL_WITH_TESTS void	onDataUnsolicited (const Data &data, const FaceEndpoint &ingress)
	Data unsolicited pipeline. More...

NFD_VIRTUAL_WITH_TESTS bool	onOutgoingData (const Data &data, Face &egress)
	outgoing Data pipeline More...

NFD_VIRTUAL_WITH_TESTS void	onIncomingNack (const lp::Nack &nack, const FaceEndpoint &ingress)
	incoming Nack pipeline More...

NFD_VIRTUAL_WITH_TESTS bool	onOutgoingNack (const lp::NackHeader &nack, Face &egress, const shared_ptr< pit::Entry > &pitEntry)
	outgoing Nack pipeline More...

NFD_VIRTUAL_WITH_TESTS void	onDroppedInterest (const Interest &interest, Face &egress)

NFD_VIRTUAL_WITH_TESTS void	onNewNextHop (const Name &prefix, const fib::NextHop &nextHop)

Public Attributes
signal::Signal< Forwarder, pit::Entry, Face, Data >	beforeSatisfyInterest
	trigger before PIT entry is satisfied More...

signal::Signal< Forwarder, pit::Entry >	beforeExpirePendingInterest
	trigger before PIT entry expires More...

signal::Signal< Forwarder, Interest, Data >	afterCsHit
	Signals when the incoming interest pipeline gets a hit from the content store. More...

signal::Signal< Forwarder, Interest >	afterCsMiss
	Signals when the incoming interest pipeline gets a miss from the content store. More...

NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: NFD_VIRTUAL_WITH_TESTS void onIncomingInterest(const Interest& interest

NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE const FaceEndpoint &	ingress

Friends
class	fw::Strategy

Detailed Description

Main class of NFD's forwarding engine.

The Forwarder class owns all tables and implements the forwarding pipelines.

Definition at line 53 of file forwarder.hpp.

Constructor & Destructor Documentation

◆ Forwarder()

nfd::Forwarder::Forwarder ( FaceTable & faceTable )

explicit

Definition at line 53 of file forwarder.cpp.

References nfd::FaceTable::addReserved(), nfd::FaceTable::afterAdd, nfd::fib::Fib::afterNewNextHop, nfd::fw::Strategy::afterReceiveLoopedInterest(), nfd::FaceTable::beforeRemove, nfd::cleanupOnFaceRemoval(), nfd::fw::DUPLICATE_NONCE_IN_SAME, nfd::fw::DUPLICATE_NONCE_NONE, Face, nfd::FaceEndpoint::face, ndn::nfd::FACE_SCOPE_NON_LOCAL, nfd::face::FACEID_CONTENT_STORE, nfd::cs::Cs::find(), nfd::fw::findDuplicateNonce(), nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), nfd::getDefaultStrategyName(), ndn::Interest::getForwardingHint(), ndn::Interest::getHopLimit(), ndn::Interest::getName(), ndn::Interest::getNonce(), nfd::DeadNonceList::has(), ingress, nfd::pit::Pit::insert(), nfd::NetworkRegionTable::isInProducerRegion(), ndn::Name::isPrefixOf(), ndn::nfd::LINK_TYPE_POINT_TO_POINT, nfd::scope_prefix::LOCALHOST, NFD_LOG_DEBUG, nfd::ForwarderCounters::nInInterests, onContentStoreHit(), onContentStoreMiss(), onDroppedInterest(), onIncomingData(), onIncomingNack(), onInterestLoop(), onNewNextHop(), nfd::strategy_choice::StrategyChoice::setDefaultStrategy(), ndn::TagHost::setTag(), and ~Forwarder().

◆ ~Forwarder()

nfd::Forwarder::~Forwarder ( )

default

Referenced by Forwarder().

Member Function Documentation

◆ getCounters()

const ForwarderCounters& nfd::Forwarder::getCounters ( ) const

inline

Definition at line 63 of file forwarder.hpp.

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager().

◆ getUnsolicitedDataPolicy()

fw::UnsolicitedDataPolicy& nfd::Forwarder::getUnsolicitedDataPolicy ( ) const

inline

Definition at line 69 of file forwarder.hpp.

◆ setUnsolicitedDataPolicy()

void nfd::Forwarder::setUnsolicitedDataPolicy ( unique_ptr< fw::UnsolicitedDataPolicy > policy )

inline

Definition at line 75 of file forwarder.hpp.

References nonstd::optional_lite::std11::move().

Referenced by nfd::TablesConfigSection::ensureConfigured().

◆ getNameTree()

NameTree& nfd::Forwarder::getNameTree ( )

inline

Definition at line 82 of file forwarder.hpp.

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and onNewNextHop().

◆ getFib()

Fib& nfd::Forwarder::getFib ( )

inline

Definition at line 88 of file forwarder.hpp.

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager(), and nfd::fw::Strategy::lookupFib().

◆ getPit()

Pit& nfd::Forwarder::getPit ( )

inline

Definition at line 94 of file forwarder.hpp.

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager().

◆ getCs()

Cs& nfd::Forwarder::getCs ( )

inline

Definition at line 100 of file forwarder.hpp.

Referenced by nfd::TablesConfigSection::ensureConfigured(), and nfd::ForwarderStatusManager::ForwarderStatusManager().

◆ getMeasurements()

Measurements& nfd::Forwarder::getMeasurements ( )

inline

Definition at line 106 of file forwarder.hpp.

Referenced by nfd::ForwarderStatusManager::ForwarderStatusManager().

◆ getStrategyChoice()

StrategyChoice& nfd::Forwarder::getStrategyChoice ( )

inline

Definition at line 112 of file forwarder.hpp.

Referenced by nfd::TablesConfigSection::ensureConfigured().

◆ getDeadNonceList()

DeadNonceList& nfd::Forwarder::getDeadNonceList ( )

inline

Definition at line 118 of file forwarder.hpp.

◆ getNetworkRegionTable()

NetworkRegionTable& nfd::Forwarder::getNetworkRegionTable ( )

inline

Definition at line 124 of file forwarder.hpp.

References nfd::general::setConfigFile().

Referenced by nfd::TablesConfigSection::ensureConfigured(), and nfd::fw::Strategy::lookupFib().

◆ setConfigFile()

void nfd::Forwarder::setConfigFile ( ConfigFile & configFile )

register handler for forwarder section of NFD configuration file

Definition at line 621 of file forwarder.cpp.

References nfd::ConfigFile::addSectionHandler(), nfd::CFG_FORWARDER, and NDN_THROW.

◆ onInterestLoop()

void nfd::Forwarder::onInterestLoop	(	const Interest &	interest,
		const FaceEndpoint &	ingress
	)

Interest loop pipeline.

Definition at line 171 of file forwarder.cpp.

References nfd::FaceEndpoint::face, ndn::Interest::getName(), ndn::nfd::LINK_TYPE_POINT_TO_POINT, and NFD_LOG_DEBUG.

Referenced by Forwarder().

◆ onContentStoreMiss()

void nfd::Forwarder::onContentStoreMiss	(	const Interest &	interest,
		const FaceEndpoint &	ingress,
		const shared_ptr< pit::Entry > &	pitEntry
	)

Content Store miss pipeline.

Definition at line 191 of file forwarder.cpp.

References afterCsMiss, nfd::fw::Strategy::afterReceiveInterest(), Face, nfd::FaceEndpoint::face, nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), nfd::FaceTable::get(), ndn::Interest::getHopLimit(), ndn::Interest::getName(), ndn::TagHost::getTag(), nfd::ForwarderCounters::nCsMisses, NFD_LOG_DEBUG, ndn::time::steady_clock::now(), and onOutgoingInterest().

Referenced by Forwarder().

◆ onContentStoreHit()

void nfd::Forwarder::onContentStoreHit	(	const Interest &	interest,
		const FaceEndpoint &	ingress,
		const shared_ptr< pit::Entry > &	pitEntry,
		const Data &	data
	)

Content Store hit pipeline.

Definition at line 235 of file forwarder.cpp.

References nfd::fw::Strategy::afterContentStoreHit(), afterCsHit, beforeSatisfyInterest, nfd::fw::Strategy::beforeSatisfyInterest(), nfd::face::FACEID_CONTENT_STORE, nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), ndn::Data::getFreshnessPeriod(), ndn::Interest::getName(), ndn::TagHost::getTag(), nfd::ForwarderCounters::nCsHits, NFD_LOG_DEBUG, and ndn::TagHost::setTag().

Referenced by Forwarder().

◆ onOutgoingInterest()

pit::OutRecord * nfd::Forwarder::onOutgoingInterest	(	const Interest &	interest,
		Face &	egress,
		const shared_ptr< pit::Entry > &	pitEntry
	)

outgoing Interest pipeline

Returns: A pointer to the out-record created or nullptr if the Interest was dropped

Definition at line 260 of file forwarder.cpp.

References ndn::nfd::FACE_SCOPE_NON_LOCAL, ndn::Interest::getHopLimit(), NFD_LOG_DEBUG, and nfd::ForwarderCounters::nOutInterests.

Referenced by onContentStoreMiss(), and nfd::fw::Strategy::sendInterest().

◆ onInterestFinalize()

void nfd::Forwarder::onInterestFinalize ( const shared_ptr< pit::Entry > & pitEntry )

Interest finalize pipeline.

Definition at line 284 of file forwarder.cpp.

References beforeExpirePendingInterest, nfd::pit::Pit::erase(), NFD_LOG_DEBUG, nfd::ForwarderCounters::nSatisfiedInterests, and nfd::ForwarderCounters::nUnsatisfiedInterests.

Referenced by onNewNextHop().

◆ onIncomingData()

void nfd::Forwarder::onIncomingData	(	const Data &	data,
		const FaceEndpoint &	ingress
	)

incoming Data pipeline

Parameters

data	the incoming Data, must be well-formed and created with make_shared
ingress	face on which `data` was received and endpoint of the sender

Definition at line 310 of file forwarder.cpp.

References beforeSatisfyInterest, nfd::FaceEndpoint::endpoint, nfd::FaceEndpoint::face, ndn::nfd::FACE_SCOPE_NON_LOCAL, nfd::pit::Pit::findAllDataMatches(), nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), ndn::Data::getFreshnessPeriod(), ndn::Data::getName(), nfd::cs::Cs::insert(), ndn::Name::isPrefixOf(), ndn::nfd::LINK_TYPE_AD_HOC, nfd::scope_prefix::LOCALHOST, NFD_LOG_DEBUG, nfd::ForwarderCounters::nInData, onDataUnsolicited(), onOutgoingData(), nfd::fw::Strategy::satisfyInterest(), and ndn::TagHost::setTag().

Referenced by Forwarder().

◆ onDataUnsolicited()

void nfd::Forwarder::onDataUnsolicited	(	const Data &	data,
		const FaceEndpoint &	ingress
	)

Data unsolicited pipeline.

Definition at line 404 of file forwarder.cpp.

References nfd::fw::CACHE, nfd::FaceEndpoint::face, ndn::Data::getName(), nfd::cs::Cs::insert(), NFD_LOG_DEBUG, and nfd::ForwarderCounters::nUnsolicitedData.

Referenced by onIncomingData().

◆ onOutgoingData()

bool nfd::Forwarder::onOutgoingData	(	const Data &	data,
		Face &	egress
	)

outgoing Data pipeline

Returns: Whether the Data was transmitted (true) or dropped (false)

Definition at line 419 of file forwarder.cpp.

References ndn::nfd::FACE_SCOPE_NON_LOCAL, ndn::Data::getName(), nfd::face::INVALID_FACEID, ndn::Name::isPrefixOf(), nfd::scope_prefix::LOCALHOST, NFD_LOG_DEBUG, NFD_LOG_WARN, and nfd::ForwarderCounters::nOutData.

Referenced by onIncomingData(), and nfd::fw::Strategy::sendData().

◆ onIncomingNack()

void nfd::Forwarder::onIncomingNack	(	const lp::Nack &	nack,
		const FaceEndpoint &	ingress
	)

incoming Nack pipeline

Parameters

nack	the incoming Nack, must be well-formed
ingress	face on which `nack` is received and endpoint of the sender

Definition at line 447 of file forwarder.cpp.

References nfd::fw::Strategy::afterReceiveNack(), nfd::FaceEndpoint::face, nfd::pit::Pit::find(), nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), ndn::lp::Nack::getInterest(), ndn::Interest::getName(), ndn::Interest::getNonce(), ndn::lp::Nack::getReason(), nfd::fw::hasPendingOutRecords(), ndn::nfd::LINK_TYPE_POINT_TO_POINT, NFD_LOG_DEBUG, nfd::ForwarderCounters::nInNacks, and ndn::TagHost::setTag().

Referenced by Forwarder().

◆ onOutgoingNack()

bool nfd::Forwarder::onOutgoingNack	(	const lp::NackHeader &	nack,
		Face &	egress,
		const shared_ptr< pit::Entry > &	pitEntry
	)

outgoing Nack pipeline

Returns: Whether the Nack was transmitted (true) or dropped (false)

Definition at line 503 of file forwarder.cpp.

References ndn::lp::NackHeader::getReason(), nfd::face::INVALID_FACEID, ndn::nfd::LINK_TYPE_POINT_TO_POINT, NFD_LOG_DEBUG, NFD_LOG_WARN, nfd::ForwarderCounters::nOutNacks, and ndn::lp::Nack::setHeader().

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

◆ onDroppedInterest()

void nfd::Forwarder::onDroppedInterest	(	const Interest &	interest,
		Face &	egress
	)

Definition at line 550 of file forwarder.cpp.

References nfd::strategy_choice::StrategyChoice::findEffectiveStrategy(), and ndn::Interest::getName().

Referenced by Forwarder().

◆ onNewNextHop()

void nfd::Forwarder::onNewNextHop	(	const Name &	prefix,
		const fib::NextHop &	nextHop
	)

Friends And Related Function Documentation

◆ fw::Strategy

friend class fw::Strategy

friend

Definition at line 274 of file forwarder.hpp.

Member Data Documentation

◆ beforeSatisfyInterest

signal::Signal<Forwarder, pit::Entry, Face, Data> nfd::Forwarder::beforeSatisfyInterest

trigger before PIT entry is satisfied

See also: Strategy::beforeSatisfyInterest

Definition at line 138 of file forwarder.hpp.

Referenced by onContentStoreHit(), and onIncomingData().

◆ beforeExpirePendingInterest

signal::Signal<Forwarder, pit::Entry> nfd::Forwarder::beforeExpirePendingInterest

trigger before PIT entry expires

See also: Strategy::beforeExpirePendingInterest

Definition at line 143 of file forwarder.hpp.

Referenced by onInterestFinalize().

◆ afterCsHit

signal::Signal<Forwarder, Interest, Data> nfd::Forwarder::afterCsHit

Signals when the incoming interest pipeline gets a hit from the content store.

Definition at line 147 of file forwarder.hpp.

Referenced by onContentStoreHit().

◆ afterCsMiss

signal::Signal<Forwarder, Interest> nfd::Forwarder::afterCsMiss

Signals when the incoming interest pipeline gets a miss from the content store.

Definition at line 151 of file forwarder.hpp.

Referenced by onContentStoreMiss().

◆ pad0

NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE nfd::Forwarder::__pad0__

Definition at line 159 of file forwarder.hpp.

◆ ingress

NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE const FaceEndpoint& nfd::Forwarder::ingress

Definition at line 159 of file forwarder.hpp.

Referenced by Forwarder().

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

ndnSIM/NFD/daemon/fw/forwarder.hpp
ndnSIM/NFD/daemon/fw/forwarder.cpp

Public Member Functions

Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Forwarder()

◆ ~Forwarder()

Member Function Documentation

◆ getCounters()

◆ getUnsolicitedDataPolicy()

◆ setUnsolicitedDataPolicy()

◆ getNameTree()

◆ getFib()

◆ getPit()

◆ getCs()

◆ getMeasurements()

◆ getStrategyChoice()

◆ getDeadNonceList()

◆ getNetworkRegionTable()

◆ setConfigFile()

◆ onInterestLoop()

◆ onContentStoreMiss()

◆ onContentStoreHit()

◆ onOutgoingInterest()

◆ onInterestFinalize()

◆ onIncomingData()

◆ onDataUnsolicited()

◆ onOutgoingData()

◆ onIncomingNack()

◆ onOutgoingNack()

◆ onDroppedInterest()

◆ onNewNextHop()

Friends And Related Function Documentation

◆ fw::Strategy

Member Data Documentation

◆ beforeSatisfyInterest

◆ beforeExpirePendingInterest

◆ afterCsHit

◆ afterCsMiss

◆ __pad0__

◆ ingress

◆ pad0