access-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_ACCESS_STRATEGY_HPP
27 #define NFD_DAEMON_FW_ACCESS_STRATEGY_HPP
28 
29 #include "strategy.hpp"
31 
32 #include <ndn-cxx/util/rtt-estimator.hpp>
33 
34 #include <unordered_map>
35 
36 namespace nfd::fw {
37 
50 class AccessStrategy : public Strategy
51 {
52 public:
53  explicit
54  AccessStrategy(Forwarder& forwarder, const Name& name = getStrategyName());
55 
56  static const Name&
58 
59 public: // triggers
60  void
61  afterReceiveInterest(const Interest& interest, const FaceEndpoint& ingress,
62  const shared_ptr<pit::Entry>& pitEntry) override;
63 
64  void
65  beforeSatisfyInterest(const Data& data, const FaceEndpoint& ingress,
66  const shared_ptr<pit::Entry>& pitEntry) override;
67 
68 private: // StrategyInfo
69  using RttEstimator = ndn::util::RttEstimator;
70 
73  class PitInfo final : public StrategyInfo
74  {
75  public:
76  static constexpr int
77  getTypeId()
78  {
79  return 1010;
80  }
81 
82  public:
83  ndn::scheduler::ScopedEventId rtoTimer;
84  };
85 
88  class MtInfo final : public StrategyInfo
89  {
90  public:
91  static constexpr int
92  getTypeId()
93  {
94  return 1011;
95  }
96 
97  explicit
98  MtInfo(shared_ptr<const RttEstimator::Options> opts)
99  : rtt(std::move(opts))
100  {
101  }
102 
103  public:
104  FaceId lastNexthop = face::INVALID_FACEID;
105  RttEstimator rtt;
106  };
107 
110  std::tuple<Name, MtInfo*>
111  findPrefixMeasurements(const pit::Entry& pitEntry);
112 
116  MtInfo*
117  addPrefixMeasurements(const Data& data);
118 
123  class FaceInfo
124  {
125  public:
126  explicit
127  FaceInfo(shared_ptr<const RttEstimator::Options> opts)
128  : rtt(std::move(opts))
129  {
130  }
131 
132  public:
133  RttEstimator rtt;
134  };
135 
136 private: // forwarding procedures
137  void
138  afterReceiveNewInterest(const Interest& interest, const FaceEndpoint& ingress,
139  const shared_ptr<pit::Entry>& pitEntry);
140 
141  void
142  afterReceiveRetxInterest(const Interest& interest, const FaceEndpoint& ingress,
143  const shared_ptr<pit::Entry>& pitEntry);
144 
148  bool
149  sendToLastNexthop(const Interest& interest, const FaceEndpoint& ingress,
150  const shared_ptr<pit::Entry>& pitEntry, MtInfo& mi,
151  const fib::Entry& fibEntry);
152 
153  void
154  afterRtoTimeout(const weak_ptr<pit::Entry>& pitWeak,
155  FaceId inFaceId, FaceId firstOutFaceId);
156 
161  size_t
162  multicast(const Interest& interest, const Face& inFace,
163  const shared_ptr<pit::Entry>& pitEntry, const fib::Entry& fibEntry,
164  FaceId exceptFace = face::INVALID_FACEID);
165 
166  void
167  updateMeasurements(const Face& inFace, const Data& data, time::nanoseconds rtt);
168 
169 private:
170  const shared_ptr<const RttEstimator::Options> m_rttEstimatorOpts;
171  std::unordered_map<FaceId, FaceInfo> m_fit;
172  RetxSuppressionFixed m_retxSuppression;
173  signal::ScopedConnection m_removeFaceConn;
174 };
175 
176 } // namespace nfd::fw
177 
178 #endif // NFD_DAEMON_FW_ACCESS_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
A forwarding strategy for "access" routers.
void afterReceiveInterest(const Interest &interest, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after an Interest is received.
static const Name & getStrategyName()
AccessStrategy(Forwarder &forwarder, const Name &name=getStrategyName())
void beforeSatisfyInterest(const Data &data, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger before a PIT entry is satisfied.
A retransmission suppression decision algorithm that suppresses retransmissions within a fixed durati...
Base class of all forwarding strategies.
Definition: strategy.hpp:46
Contains arbitrary information placed by the forwarding strategy on table entries.
Represents an entry in the Interest table (PIT).
Definition: pit-entry.hpp:197
constexpr FaceId INVALID_FACEID
Indicates an invalid FaceId.
Definition: face-common.hpp:51
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:48