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

Best Route strategy version 1. More...

#include <best-route-strategy.hpp>

Inheritance diagram for nfd::fw::BestRouteStrategy:
Collaboration diagram for nfd::fw::BestRouteStrategy:

Public Member Functions

 BestRouteStrategy (Forwarder &forwarder, const Name &name=STRATEGY_NAME)
 
virtual ~BestRouteStrategy ()
 
virtual void afterReceiveInterest (const Face &inFace, const Interest &interest, shared_ptr< fib::Entry > fibEntry, shared_ptr< pit::Entry > pitEntry) 1
 trigger after Interest is received More...
 
- Public Member Functions inherited from nfd::fw::Strategy
 Strategy (Forwarder &forwarder, const Name &name)
 construct a strategy instance More...
 
virtual ~Strategy ()
 
const NamegetName () const
 a Name that represent the Strategy program More...
 
virtual void beforeSatisfyInterest (shared_ptr< pit::Entry > pitEntry, const Face &inFace, const Data &data)
 trigger before PIT entry is satisfied More...
 
virtual void beforeExpirePendingInterest (shared_ptr< pit::Entry > pitEntry)
 trigger before PIT entry expires More...
 
virtual void afterReceiveNack (const Face &inFace, const lp::Nack &nack, shared_ptr< fib::Entry > fibEntry, shared_ptr< pit::Entry > pitEntry)
 trigger after Nack is received More...
 

Static Public Attributes

static const Name STRATEGY_NAME
 

Additional Inherited Members

- Protected Member Functions inherited from nfd::fw::Strategy
void sendInterest (shared_ptr< pit::Entry > pitEntry, shared_ptr< Face > outFace, bool wantNewNonce=false)
 send Interest to outFace More...
 
void rejectPendingInterest (shared_ptr< pit::Entry > pitEntry)
 decide that a pending Interest cannot be forwarded More...
 
void sendNack (shared_ptr< pit::Entry > pitEntry, const Face &outFace, const lp::NackHeader &header)
 send Nack to outFace More...
 
void sendNacks (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...
 
MeasurementsAccessorgetMeasurements ()
 
shared_ptr< Face > getFace (FaceId id)
 
const FaceTablegetFaceTable ()
 
- Protected Attributes inherited from nfd::fw::Strategy
signal::Signal< FaceTable, shared_ptr< Face > > & afterAddFace
 
signal::Signal< FaceTable, shared_ptr< Face > > & beforeRemoveFace
 

Detailed Description

Best Route strategy version 1.

This strategy forwards a new Interest to the lowest-cost nexthop that is not same as the downstream, and does not violate scope. Subsequent similar Interests or consumer retransmissions are suppressed until after InterestLifetime expiry.

Deprecated:
This strategy is superceded by Best Route strategy version 2, which allows consumer retransmissions. This version is kept for comparison purposes and is not recommended for general usage.

Definition at line 45 of file best-route-strategy.hpp.

Constructor & Destructor Documentation

§ BestRouteStrategy()

nfd::fw::BestRouteStrategy::BestRouteStrategy ( Forwarder forwarder,
const Name name = STRATEGY_NAME 
)

Definition at line 34 of file best-route-strategy.cpp.

§ ~BestRouteStrategy()

nfd::fw::BestRouteStrategy::~BestRouteStrategy ( )
virtual

Definition at line 39 of file best-route-strategy.cpp.

Member Function Documentation

§ afterReceiveInterest()

void nfd::fw::BestRouteStrategy::afterReceiveInterest ( const Face &  inFace,
const Interest interest,
shared_ptr< fib::Entry fibEntry,
shared_ptr< pit::Entry pitEntry 
)
virtual

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 strategy should decide whether and where to forward this Interest.

  • If the strategy decides to forward this Interest, invoke this->sendInterest one or more times, either now or shortly after
  • If strategy concludes that this Interest cannot be forwarded, invoke this->rejectPendingInterest so that PIT entry will be deleted shortly
Note
The strategy is permitted to store a weak reference to fibEntry. Do not store a shared reference, because FIB entry may be deleted at any moment. fibEntry is passed by value to allow obtaining a weak reference from it.
The strategy is permitted to store a shared reference to pitEntry. pitEntry is passed by value to reflect this fact.

Implements nfd::fw::Strategy.

Reimplemented in nfd::fw::ClientControlStrategy.

Definition at line 51 of file best-route-strategy.cpp.

References nfd::fw::predicate_PitEntry_canForwardTo_NextHop(), nfd::fw::Strategy::rejectPendingInterest(), and nfd::fw::Strategy::sendInterest().

Referenced by nfd::fw::ClientControlStrategy::afterReceiveInterest().

Member Data Documentation

§ STRATEGY_NAME

const Name nfd::fw::BestRouteStrategy::STRATEGY_NAME
static

Definition at line 60 of file best-route-strategy.hpp.


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