NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
nfd::fw::asf::AsfStrategy Class Reference

Adaptive SRTT-based Forwarding Strategy. More...

#include <asf-strategy.hpp>

Inheritance diagram for nfd::fw::asf::AsfStrategy:
Collaboration diagram for nfd::fw::asf::AsfStrategy:

Public Member Functions

 AsfStrategy (Forwarder &forwarder, const Name &name=getStrategyName())
 
void afterReceiveInterest (const Face &inFace, 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 Face &inFace, const Data &data) override
 trigger before PIT entry is satisfied More...
 
void afterReceiveNack (const Face &inFace, 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 NamegetInstanceName () const
 
virtual void afterContentStoreHit (const shared_ptr< pit::Entry > &pitEntry, const Face &inFace, const Data &data)
 trigger after a Data is matched in CS More...
 
virtual void afterReceiveData (const shared_ptr< pit::Entry > &pitEntry, const Face &inFace, const Data &data)
 trigger after Data is received More...
 
virtual void onDroppedInterest (const Face &outFace, const Interest &interest)
 trigger after Interest dropped for exceeding allowed retransmissions More...
 

Static Public Member Functions

static const NamegetStrategyName ()
 
- 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< Strategycreate (const Name &instanceName, Forwarder &forwarder)
 
static bool areSameType (const Name &instanceNameA, const Name &instanceNameB)
 
static std::set< NamelistRegistered ()
 
static const NamegetStrategyName ()
 

Additional Inherited Members

- Protected Member Functions inherited from nfd::fw::Strategy
void sendInterest (const shared_ptr< pit::Entry > &pitEntry, Face &outFace, const Interest &interest)
 send Interest to outFace More...
 
void sendData (const shared_ptr< pit::Entry > &pitEntry, const Data &data, const Face &outFace)
 send data to outFace More...
 
void sendDataToAll (const shared_ptr< pit::Entry > &pitEntry, const Face &inFace, const Data &data)
 send data to all matched and qualified faces 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 Face &outFace, const lp::NackHeader &header)
 send Nack to outFace More...
 
void sendNacks (const shared_ptr< pit::Entry > &pitEntry, const lp::NackHeader &header, std::initializer_list< const Face * > exceptFaces=std::initializer_list< const Face * >())
 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::EntrylookupFib (const pit::Entry &pitEntry) const
 performs a FIB lookup, considering Link object if present More...
 
MeasurementsAccessorgetMeasurements ()
 
FacegetFace (FaceId id) const
 
const FaceTablegetFaceTable () 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

Adaptive SRTT-based Forwarding Strategy.

See also
Vince Lehman, Ashlesh Gawande, Rodrigo Aldecoa, Dmitri Krioukov, Beichuan Zhang, Lixia Zhang, and Lan Wang, "An Experimental Investigation of Hyperbolic Routing with a Smart Forwarding Plane in NDN," NDN Technical Report NDN-0042, 2016. http://named-data.net/techreports.html

Definition at line 44 of file asf-strategy.hpp.

Constructor & Destructor Documentation

◆ AsfStrategy()

Member Function Documentation

◆ getStrategyName()

const Name & nfd::fw::asf::AsfStrategy::getStrategyName ( )
static

Definition at line 66 of file asf-strategy.cpp.

Referenced by AsfStrategy().

◆ afterReceiveInterest()

void nfd::fw::asf::AsfStrategy::afterReceiveInterest ( const Face inFace,
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 111 of file asf-strategy.cpp.

References nfd::fw::asf::ProbingModule::afterForwardingProbe(), nfd::fw::RetxSuppressionExponential::decidePerPitEntry(), nfd::fw::FORWARD, nfd::fw::asf::ProbingModule::getFaceToProbe(), nfd::face::Face::getId(), nfd::fib::Entry::getNextHops(), nfd::fw::asf::ProbingModule::isProbingNeeded(), nfd::fw::Strategy::lookupFib(), nfd::fw::NEW, NFD_LOG_DEBUG, NFD_LOG_TRACE, nfd::fw::Strategy::rejectPendingInterest(), and nfd::fw::SUPPRESS.

◆ beforeSatisfyInterest()

void nfd::fw::asf::AsfStrategy::beforeSatisfyInterest ( const shared_ptr< pit::Entry > &  pitEntry,
const Face inFace,
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 160 of file asf-strategy.cpp.

References nfd::fw::asf::FaceInfo::cancelTimeoutEvent(), nfd::fw::asf::NamespaceInfo::extendFaceInfoLifetime(), nfd::fw::asf::NamespaceInfo::get(), nfd::face::Face::getId(), ndn::Data::getName(), nfd::fw::asf::AsfMeasurements::getNamespaceInfo(), nfd::fw::asf::FaceInfo::isTimeoutScheduled(), NFD_LOG_TRACE, and nfd::fw::asf::FaceInfo::recordRtt().

◆ afterReceiveNack()

void nfd::fw::asf::AsfStrategy::afterReceiveNack ( const Face inFace,
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 186 of file asf-strategy.cpp.

References nfd::face::Face::getId(), ndn::lp::Nack::getInterest(), ndn::lp::Nack::getReason(), and NFD_LOG_DEBUG.


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