self-learning-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-2022, 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_SELF_LEARNING_STRATEGY_HPP
27 #define NFD_DAEMON_FW_SELF_LEARNING_STRATEGY_HPP
28 
29 #include "fw/strategy.hpp"
30 
31 #include <ndn-cxx/prefix-announcement.hpp>
32 
33 namespace nfd::fw {
34 
44 {
45 public:
46  explicit
47  SelfLearningStrategy(Forwarder& forwarder, const Name& name = getStrategyName());
48 
49  static const Name&
51 
53  class InRecordInfo final : public StrategyInfo
54  {
55  public:
56  static constexpr int
58  {
59  return 1040;
60  }
61 
62  public:
63  bool isNonDiscoveryInterest = false;
64  };
65 
67  class OutRecordInfo final : public StrategyInfo
68  {
69  public:
70  static constexpr int
72  {
73  return 1041;
74  }
75 
76  public:
77  bool isNonDiscoveryInterest = false;
78  };
79 
80 public: // triggers
81  void
82  afterReceiveInterest(const Interest& interest, const FaceEndpoint& ingress,
83  const shared_ptr<pit::Entry>& pitEntry) override;
84 
85  void
86  afterReceiveData(const Data& data, const FaceEndpoint& ingress,
87  const shared_ptr<pit::Entry>& pitEntry) override;
88 
89  void
90  afterReceiveNack(const lp::Nack& nack, const FaceEndpoint& ingress,
91  const shared_ptr<pit::Entry>& pitEntry) override;
92 
93 private: // operations
102  void
103  broadcastInterest(const Interest& interest, const Face& inFace,
104  const shared_ptr<pit::Entry>& pitEntry);
105 
108  void
109  multicastInterest(const Interest& interest, const Face& inFace,
110  const shared_ptr<pit::Entry>& pitEntry,
111  const fib::NextHopList& nexthops);
112 
116  void
117  asyncProcessData(const shared_ptr<pit::Entry>& pitEntry, const Face& inFace, const Data& data);
118 
126  static bool
127  needPrefixAnn(const shared_ptr<pit::Entry>& pitEntry);
128 
131  void
132  addRoute(const shared_ptr<pit::Entry>& pitEntry, const Face& inFace,
133  const Data& data, const ndn::PrefixAnnouncement& pa);
134 
137  void
138  renewRoute(const Name& name, FaceId inFaceId, time::milliseconds maxLifetime);
139 };
140 
141 } // namespace nfd::fw
142 
143 #endif // NFD_DAEMON_FW_SELF_LEARNING_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
Self-learning forwarding strategy.
void afterReceiveNack(const lp::Nack &nack, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after a Nack is received.
void afterReceiveData(const Data &data, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after Data is received.
void afterReceiveInterest(const Interest &interest, const FaceEndpoint &ingress, const shared_ptr< pit::Entry > &pitEntry) override
Trigger after an Interest is received.
SelfLearningStrategy(Forwarder &forwarder, const Name &name=getStrategyName())
Base class of all forwarding strategies.
Definition: strategy.hpp:46
Contains arbitrary information placed by the forwarding strategy on table entries.
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:48
std::vector< NextHop > NextHopList
A collection of nexthops in a FIB entry.
Definition: fib-entry.hpp:84