NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2019, 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 
32 
33 namespace nfd {
34 namespace fw {
35 
46 {
47 public:
48  explicit
49  SelfLearningStrategy(Forwarder& forwarder, const Name& name = getStrategyName());
50 
51  static const Name&
53 
55  class InRecordInfo : public StrategyInfo
56  {
57  public:
58  static constexpr int
60  {
61  return 1040;
62  }
63 
64  public:
65  bool isNonDiscoveryInterest = false;
66  };
67 
69  class OutRecordInfo : public StrategyInfo
70  {
71  public:
72  static constexpr int
74  {
75  return 1041;
76  }
77 
78  public:
79  bool isNonDiscoveryInterest = false;
80  };
81 
82 public: // triggers
83  void
84  afterReceiveInterest(const FaceEndpoint& ingress, const Interest& interest,
85  const shared_ptr<pit::Entry>& pitEntry) override;
86 
87  void
88  afterReceiveData(const shared_ptr<pit::Entry>& pitEntry,
89  const FaceEndpoint& ingress, const Data& data) override;
90 
91  void
92  afterReceiveNack(const FaceEndpoint& ingress, const lp::Nack& nack,
93  const shared_ptr<pit::Entry>& pitEntry) override;
94 
95 private: // operations
96 
105  void
106  broadcastInterest(const Interest& interest, const Face& inFace,
107  const shared_ptr<pit::Entry>& pitEntry);
108 
111  void
112  multicastInterest(const Interest& interest, const Face& inFace,
113  const shared_ptr<pit::Entry>& pitEntry,
114  const fib::NextHopList& nexthops);
115 
119  void
120  asyncProcessData(const shared_ptr<pit::Entry>& pitEntry, const Face& inFace, const Data& data);
121 
129  static bool
130  needPrefixAnn(const shared_ptr<pit::Entry>& pitEntry);
131 
134  void
135  addRoute(const shared_ptr<pit::Entry>& pitEntry, const Face& inFace,
136  const Data& data, const ndn::PrefixAnnouncement& pa);
137 
140  void
141  renewRoute(const Name& name, FaceId inFaceId, time::milliseconds maxLifetime);
142 
143 private:
144  static const time::milliseconds ROUTE_RENEW_LIFETIME;
145 };
146 
147 } // namespace fw
148 } // namespace nfd
149 
150 #endif // NFD_DAEMON_FW_SELF_LEARNING_STRATEGY_HPP
nfd::fw::SelfLearningStrategy::SelfLearningStrategy
SelfLearningStrategy(Forwarder &forwarder, const Name &name=getStrategyName())
Definition: self-learning-strategy.cpp:47
nfd::fw::SelfLearningStrategy::OutRecordInfo::isNonDiscoveryInterest
bool isNonDiscoveryInterest
Definition: self-learning-strategy.hpp:79
ndn::PrefixAnnouncement
A prefix announcement object that represents an application's intent of registering a prefix toward i...
Definition: prefix-announcement.hpp:34
nfd::fw::SelfLearningStrategy::afterReceiveNack
void afterReceiveNack(const FaceEndpoint &ingress, const lp::Nack &nack, const shared_ptr< pit::Entry > &pitEntry) override
trigger after Nack is received
Definition: self-learning-strategy.cpp:133
ndn::Name
Represents an absolute name.
Definition: name.hpp:44
nfd::fw::SelfLearningStrategy::afterReceiveData
void afterReceiveData(const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data) override
trigger after Data is received
Definition: self-learning-strategy.cpp:103
nfd
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
nfd::fw::StrategyInfo
contains arbitrary information forwarding strategy places on table entries
Definition: strategy-info.hpp:37
nfd::face::FaceId
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:44
nfd::face::Face
generalization of a network interface
Definition: face.hpp:53
nfd::FaceEndpoint
Represents a face-endpoint pair in the forwarder.
Definition: face-endpoint.hpp:37
nfd::fw::SelfLearningStrategy::OutRecordInfo::getTypeId
static constexpr int getTypeId()
Definition: self-learning-strategy.hpp:73
nfd::fw::SelfLearningStrategy
Self-learning strategy.
Definition: self-learning-strategy.hpp:46
ndn::Interest
Represents an Interest packet.
Definition: interest.hpp:44
nfd::fw::SelfLearningStrategy::InRecordInfo::getTypeId
static constexpr int getTypeId()
Definition: self-learning-strategy.hpp:59
nfd::fib::NextHopList
std::vector< NextHop > NextHopList
Definition: fib-entry.hpp:49
ndn::Data
Represents a Data packet.
Definition: data.hpp:36
nfd::fw::Strategy
represents a forwarding strategy
Definition: strategy.hpp:38
nfd::Forwarder
Main class of NFD's forwarding engine.
Definition: forwarder.hpp:52
nfd::fw::SelfLearningStrategy::InRecordInfo
StrategyInfo on pit::InRecord.
Definition: self-learning-strategy.hpp:56
ndn::lp::Nack
represents a Network Nack
Definition: nack.hpp:39
strategy.hpp
ndn::name
Definition: name-component-types.hpp:33
nfd::fw::SelfLearningStrategy::OutRecordInfo
StrategyInfo on pit::OutRecord.
Definition: self-learning-strategy.hpp:70
prefix-announcement-header.hpp
nfd::fw::SelfLearningStrategy::InRecordInfo::isNonDiscoveryInterest
bool isNonDiscoveryInterest
Definition: self-learning-strategy.hpp:65
nfd::fw::SelfLearningStrategy::getStrategyName
static const Name & getStrategyName()
Definition: self-learning-strategy.cpp:62
nfd::fw::SelfLearningStrategy::afterReceiveInterest
void afterReceiveInterest(const FaceEndpoint &ingress, const Interest &interest, const shared_ptr< pit::Entry > &pitEntry) override
trigger after Interest is received
Definition: self-learning-strategy.cpp:69