represents a forwarding strategy More...
#include <strategy.hpp>
Classes | |
struct | ParsedInstanceName |
Public Member Functions | |
Strategy (Forwarder &forwarder) | |
Construct a strategy instance. More... | |
virtual | ~Strategy () |
const Name & | getInstanceName () const |
bool | wantNewNextHopTrigger () const |
virtual void | afterReceiveInterest (const FaceEndpoint &ingress, const Interest &interest, const shared_ptr< pit::Entry > &pitEntry)=0 |
trigger after Interest is received More... | |
virtual void | afterReceiveLoopedInterest (const FaceEndpoint &ingress, const Interest &interest, pit::Entry &pitEntry) |
trigger after a looped Interest is received More... | |
virtual void | beforeSatisfyInterest (const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data) |
trigger before PIT entry is satisfied 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 | |
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 | |
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 Member Functions | |
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 | |
signal::Signal< FaceTable, Face > & | afterAddFace |
signal::Signal< FaceTable, Face > & | beforeRemoveFace |
represents a forwarding strategy
Definition at line 37 of file strategy.hpp.
|
explicit |
Construct a strategy instance.
forwarder | a reference to the forwarder, used to enable actions and accessors. |
forwarder
. Definition at line 143 of file strategy.cpp.
|
virtualdefault |
|
inlinestatic |
register a strategy type
S | subclass of Strategy |
strategyName | strategy program name, must contain version |
Definition at line 48 of file strategy.hpp.
|
static |
instanceName
instanceName | strategy instance name, may contain version and parameters |
create
, but does not attempt to construct an instance. Definition at line 86 of file strategy.cpp.
|
static |
instanceName
nullptr | if !canCreate(instanceName) |
std::invalid_argument | strategy type constructor does not accept specified version or parameters |
Definition at line 92 of file strategy.cpp.
References NFD_LOG_DEBUG.
Referenced by nfd::strategy_choice::StrategyChoice::insert(), and nfd::strategy_choice::StrategyChoice::setDefaultStrategy().
|
static |
instanceNameA
and instanceNameA
will initiate same strategy type Definition at line 108 of file strategy.cpp.
|
static |
Definition at line 114 of file strategy.cpp.
|
static |
The strategy name is defined by the strategy program. It must end with a version component.
|
inline |
The instance name is assigned during instantiation. It contains a version component, and may have extra parameter components.
Definition at line 112 of file strategy.hpp.
Referenced by nfd::strategy_choice::Entry::getStrategyInstanceName(), and nfd::strategy_choice::StrategyChoice::insert().
|
inline |
Definition at line 120 of file strategy.hpp.
|
pure virtual |
trigger after Interest is received
The Interest:
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.
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.setExpiryTimer
to adjust how long it would wait for a response.rejectPendingInterest
to erase the PIT entry.Implemented in nfd::fw::SelfLearningStrategy, nfd::fw::BestRouteStrategy2, nfd::fw::AccessStrategy, nfd::fw::asf::AsfStrategy, nfd::fw::RandomStrategy, nfd::fw::MulticastStrategy, nfd::fw::NccStrategy, and nfd::fw::BestRouteStrategyBase.
|
virtual |
trigger after a looped Interest is received
The Interest:
Definition at line 155 of file strategy.cpp.
References nfd::pit::Entry::getName(), and NFD_LOG_DEBUG.
|
virtual |
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.
Reimplemented in nfd::fw::AccessStrategy, nfd::fw::asf::AsfStrategy, and nfd::fw::NccStrategy.
Definition at line 163 of file strategy.cpp.
References ndn::Data::getName(), and NFD_LOG_DEBUG.
Referenced by afterReceiveData().
|
virtual |
trigger after a Data is matched in CS
In the base class this method sends data
to ingress
Definition at line 171 of file strategy.cpp.
References ndn::Data::getName(), NFD_LOG_DEBUG, and sendData().
|
virtual |
trigger after Data is received
This trigger is invoked when an incoming Data satisfies exactly one PIT entry, and gives the strategy full control over Data forwarding.
When this trigger is invoked:
Within this function:
sendData
or sendDataToAll
.setExpiryTimer
, and forward Data before the PIT entry is erased.setExpiryTimer
every time a Data is received. Note that only one Data should be returned to each downstream node.In the base class this method invokes beforeSatisfyInterest
trigger and then returns the Data to downstream faces via sendDataToAll
.
Reimplemented in nfd::fw::SelfLearningStrategy.
Definition at line 181 of file strategy.cpp.
References beforeSatisfyInterest(), ndn::Data::getName(), NFD_LOG_DEBUG, and sendDataToAll().
|
virtual |
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.
Reimplemented in nfd::fw::SelfLearningStrategy, nfd::fw::BestRouteStrategy2, nfd::fw::asf::AsfStrategy, nfd::fw::RandomStrategy, and nfd::fw::MulticastStrategy.
Definition at line 193 of file strategy.cpp.
References NFD_LOG_DEBUG.
|
virtual |
trigger after Interest dropped for exceeding allowed retransmissions
In the base class this method does nothing.
Definition at line 200 of file strategy.cpp.
References ndn::Interest::getName(), and NFD_LOG_DEBUG.
|
virtual |
trigger after new nexthop is added
The strategy should decide whether to send the buffered Interests to the new nexthop. In the base class, this method does nothing.
Definition at line 219 of file strategy.cpp.
References nfd::fib::NextHop::getFace(), nfd::face::Face::getId(), and NFD_LOG_DEBUG.
|
protected |
send Interest to egress
pitEntry | PIT entry |
egress | face through which to send out the Interest and destination endpoint |
interest | the Interest packet |
Definition at line 206 of file strategy.cpp.
References ndn::TagHost::getTag(), and ndn::TagHost::removeTag().
Referenced by nfd::fw::BestRouteStrategyBase::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::RandomStrategy::afterReceiveInterest(), nfd::fw::asf::AsfStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy2::afterReceiveInterest(), and nfd::fw::NccStrategy::doPropagate().
|
protected |
send data
to egress
pitEntry | PIT entry |
data | the Data packet |
egress | face through which to send out the Data and destination endpoint |
Definition at line 226 of file strategy.cpp.
References nfd::FaceEndpoint::face, and ndn::TagHost::setTag().
Referenced by afterContentStoreHit(), and sendDataToAll().
|
protected |
send data
to all matched and qualified face-endpoint pairs
A matched face is qualified if it is ad-hoc or it is NOT ingress
pitEntry | PIT entry |
ingress | face through which the Data comes from and endpoint of the sender |
data | the Data packet |
Definition at line 251 of file strategy.cpp.
References nfd::FaceEndpoint::face, nfd::face::Face::getId(), ndn::nfd::LINK_TYPE_AD_HOC, ndn::time::steady_clock::now(), and sendData().
Referenced by nfd::fw::SelfLearningStrategy::afterReceiveData(), and afterReceiveData().
|
inlineprotected |
schedule the PIT entry for immediate deletion
This helper function sets the PIT entry expiry time to zero. The strategy should invoke this function when it concludes that the Interest cannot be forwarded and it does not want to wait for responses from existing upstream nodes.
Definition at line 302 of file strategy.hpp.
References setExpiryTimer().
Referenced by nfd::fw::BestRouteStrategyBase::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::RandomStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy2::afterReceiveInterest(), and nfd::fw::SelfLearningStrategy::afterReceiveInterest().
|
inlineprotected |
send Nack to egress
pitEntry | PIT entry |
egress | face through which to send out the Nack and destination endpoint |
header | Nack header |
The egress must have a PIT in-record, otherwise this method has no effect.
Definition at line 315 of file strategy.hpp.
Referenced by nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::RandomStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy2::afterReceiveInterest(), nfd::fw::SelfLearningStrategy::afterReceiveInterest(), and sendNacks().
|
protected |
send Nack to every face-endpoint pair that has an in-record, except those in exceptFaceEndpoints
pitEntry | PIT entry |
header | NACK header |
exceptFaceEndpoints | list of face-endpoint pairs that should be excluded from sending Nacks |
Definition at line 274 of file strategy.cpp.
References sendNack().
Referenced by nfd::fw::SelfLearningStrategy::afterReceiveNack().
|
inlineprotected |
Schedule the PIT entry to be erased after duration
.
Definition at line 334 of file strategy.hpp.
Referenced by rejectPendingInterest().
|
protected |
performs a FIB lookup, considering Link object if present
Definition at line 297 of file strategy.cpp.
References ndn::DelegationList::empty(), nfd::fib::Fib::findLongestPrefixMatch(), nfd::Forwarder::getFib(), ndn::Interest::getForwardingHint(), nfd::pit::Entry::getInterest(), nfd::Forwarder::getNetworkRegionTable(), nfd::fib::Entry::getPrefix(), nfd::fib::Entry::hasNextHops(), nfd::NetworkRegionTable::isInProducerRegion(), NFD_LOG_TRACE, and ndn::Name::size().
Referenced by nfd::fw::BestRouteStrategyBase::afterReceiveInterest(), nfd::fw::NccStrategy::afterReceiveInterest(), nfd::fw::MulticastStrategy::afterReceiveInterest(), nfd::fw::RandomStrategy::afterReceiveInterest(), nfd::fw::asf::AsfStrategy::afterReceiveInterest(), nfd::fw::BestRouteStrategy2::afterReceiveInterest(), nfd::fw::SelfLearningStrategy::afterReceiveInterest(), nfd::fw::SelfLearningStrategy::afterReceiveNack(), and nfd::fw::NccStrategy::doPropagate().
|
inlineprotected |
Definition at line 346 of file strategy.hpp.
Referenced by nfd::fw::NccStrategy::beforeSatisfyInterest(), nfd::fw::NccStrategy::getMeasurementsEntryInfo(), and nfd::fw::NccStrategy::timeoutOnBestFace().
|
inlineprotected |
Definition at line 352 of file strategy.hpp.
References nfd::FaceTable::get(), and getFaceTable().
Referenced by nfd::fw::NccStrategy::doPropagate().
|
inlineprotected |
Definition at line 358 of file strategy.hpp.
Referenced by getFace().
|
staticprotected |
parse a strategy instance name
input | strategy instance name, may contain version and parameters |
std::invalid_argument | input format is unacceptable |
Definition at line 123 of file strategy.cpp.
References ndn::Name::getPrefix(), ndn::Name::getSubName(), nonstd::optional_lite::nullopt, and ndn::Name::size().
Referenced by nfd::fw::asf::AsfStrategy::AsfStrategy(), nfd::fw::BestRouteStrategy::BestRouteStrategy(), nfd::fw::BestRouteStrategy2::BestRouteStrategy2(), nfd::fw::MulticastStrategy::MulticastStrategy(), nfd::fw::NccStrategy::NccStrategy(), nfd::fw::RandomStrategy::RandomStrategy(), and nfd::fw::SelfLearningStrategy::SelfLearningStrategy().
|
staticprotected |
construct a strategy instance name
input | strategy instance name, may contain version and parameters |
strategyName | strategy name with version but without parameters; typically this should be getStrategyName() |
If input
contains a version component, return input
unchanged. Otherwise, return input
plus the version component taken from strategyName
. This allows a strategy instance to be constructed with an unversioned name, but its final instance name should contain the version.
Definition at line 134 of file strategy.cpp.
References ndn::Name::at(), ndn::name::Component::isVersion(), ns3::ndn::Name, ndn::Name::rbegin(), and ndn::Name::rend().
Referenced by nfd::fw::asf::AsfStrategy::AsfStrategy(), nfd::fw::BestRouteStrategy::BestRouteStrategy(), nfd::fw::BestRouteStrategy2::BestRouteStrategy2(), nfd::fw::MulticastStrategy::MulticastStrategy(), nfd::fw::NccStrategy::NccStrategy(), nfd::fw::RandomStrategy::RandomStrategy(), and nfd::fw::SelfLearningStrategy::SelfLearningStrategy().
|
inlineprotected |
set strategy instance name
Definition at line 395 of file strategy.hpp.
Referenced by nfd::fw::asf::AsfStrategy::AsfStrategy(), nfd::fw::BestRouteStrategy::BestRouteStrategy(), nfd::fw::BestRouteStrategy2::BestRouteStrategy2(), nfd::fw::MulticastStrategy::MulticastStrategy(), nfd::fw::NccStrategy::NccStrategy(), nfd::fw::RandomStrategy::RandomStrategy(), and nfd::fw::SelfLearningStrategy::SelfLearningStrategy().
|
inlineprotected |
set whether the afterNewNextHop trigger should be invoked for this strategy
Definition at line 404 of file strategy.hpp.
|
protected |
Definition at line 420 of file strategy.hpp.
|
protected |
Definition at line 421 of file strategy.hpp.