asf-strategy.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2024, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #ifndef NFD_DAEMON_FW_ASF_STRATEGY_HPP
27 #define NFD_DAEMON_FW_ASF_STRATEGY_HPP
28 
29 #include "strategy.hpp"
30 #include "asf-measurements.hpp"
31 #include "asf-probing-module.hpp"
32 #include "process-nack-traits.hpp"
34 
35 namespace nfd::fw {
36 namespace asf {
37 
46 class AsfStrategy : public Strategy, public ProcessNackTraits<AsfStrategy>
47 {
48 public:
49  explicit
50  AsfStrategy(Forwarder& forwarder, const Name& name = getStrategyName());
51 
52  static const Name&
54 
55 public: // triggers
56  void
57  afterReceiveInterest(const Interest& interest, const FaceEndpoint& ingress,
58  const shared_ptr<pit::Entry>& pitEntry) override;
59 
60  void
61  beforeSatisfyInterest(const Data& data, const FaceEndpoint& ingress,
62  const shared_ptr<pit::Entry>& pitEntry) override;
63 
64  void
65  afterReceiveNack(const lp::Nack& nack, const FaceEndpoint& ingress,
66  const shared_ptr<pit::Entry>& pitEntry) override;
67 
68 private:
70  forwardInterest(const Interest& interest, Face& outFace, const fib::Entry& fibEntry,
71  const shared_ptr<pit::Entry>& pitEntry);
72 
73  void
74  sendProbe(const Interest& interest, const FaceEndpoint& ingress, const Face& faceToUse,
75  const fib::Entry& fibEntry, const shared_ptr<pit::Entry>& pitEntry);
76 
77  Face*
78  getBestFaceForForwarding(const Interest& interest, const Face& inFace,
79  const fib::Entry& fibEntry, const shared_ptr<pit::Entry>& pitEntry,
80  bool isNewInterest = true);
81 
82  void
83  onTimeoutOrNack(const Name& interestName, FaceId faceId, bool isNack);
84 
85  void
86  sendNoRouteNack(Face& face, const shared_ptr<pit::Entry>& pitEntry);
87 
89  struct FaceStatsForwardingCompare
90  {
91  bool
92  operator()(const FaceStats& lhs, const FaceStats& rhs) const noexcept;
93  };
94  using FaceStatsForwardingSet = std::set<FaceStats, FaceStatsForwardingCompare>;
95 
96  AsfMeasurements m_measurements{getMeasurements()};
97  std::unique_ptr<RetxSuppressionExponential> m_retxSuppression;
98  ProbingModule m_probing{m_measurements};
99  size_t m_nMaxTimeouts = 3;
100 
102 };
103 
104 } // namespace asf
105 
106 using asf::AsfStrategy;
107 
108 } // namespace nfd::fw
109 
110 #endif // NFD_DAEMON_FW_ASF_STRATEGY_HPP
Represents a face-endpoint pair in the forwarder.
Main class of NFD's forwarding engine.
Definition: forwarder.hpp:54
Generalization of a network interface.
Definition: face.hpp:118
Represents an entry in the FIB.
Definition: fib-entry.hpp:91
Base class of all forwarding strategies.
Definition: strategy.hpp:46
MeasurementsAccessor & getMeasurements() noexcept
Definition: strategy.hpp:399
Helper class to retrieve and create strategy measurements.
Adaptive SRTT-based forwarding strategy.
static const Name & getStrategyName()
void afterReceiveNack(const lp::Nack &nack, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after a Nack is received.
AsfStrategy(Forwarder &forwarder, const Name &name=getStrategyName())
void afterReceiveInterest(const Interest &interest, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after an Interest is received.
void beforeSatisfyInterest(const Data &data, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger before a PIT entry is satisfied.
Contains information about an Interest toward an outgoing face.
Definition: pit-entry.hpp:129
#define NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE
Definition: common.hpp:41
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:48
Container for ranking-related values.