ncc-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_NCC_STRATEGY_HPP
27 #define NFD_DAEMON_FW_NCC_STRATEGY_HPP
28 
29 #include "strategy.hpp"
30 
31 namespace nfd {
32 namespace fw {
33 
38 class NccStrategy : public Strategy
39 {
40 public:
41  explicit
42  NccStrategy(Forwarder& forwarder, const Name& name = getStrategyName());
43 
44  static const Name&
46 
47  void
48  afterReceiveInterest(const FaceEndpoint& ingress, const Interest& interest,
49  const shared_ptr<pit::Entry>& pitEntry) override;
50 
51  void
52  beforeSatisfyInterest(const shared_ptr<pit::Entry>& pitEntry,
53  const FaceEndpoint& ingress, const Data& data) override;
54 
58  {
59  public:
60  static constexpr int
62  {
63  return 1000;
64  }
65 
67 
68  void
69  inheritFrom(const MeasurementsEntryInfo& other);
70 
71  shared_ptr<Face>
72  getBestFace();
73 
74  void
75  updateBestFace(const Face& face);
76 
77  void
79 
80  private:
81  void
82  adjustPredictDown();
83 
84  void
85  ageBestFace();
86 
87  public:
88  weak_ptr<Face> bestFace;
89  weak_ptr<Face> previousFace;
90  time::microseconds prediction;
91 
92  static const time::microseconds INITIAL_PREDICTION;
93  static const time::microseconds MIN_PREDICTION;
94  static const int ADJUST_PREDICT_DOWN_SHIFT = 7;
95  static const time::microseconds MAX_PREDICTION;
96  static const int ADJUST_PREDICT_UP_SHIFT = 3;
97  };
98 
100  class PitEntryInfo : public StrategyInfo
101  {
102  public:
103  static constexpr int
105  {
106  return 1001;
107  }
108 
109  ~PitEntryInfo() override;
110 
111  public:
113  scheduler::EventId bestFaceTimeout;
115  scheduler::EventId propagateTimer;
117  time::microseconds maxInterval;
118  };
119 
120 protected:
123 
125  getMeasurementsEntryInfo(const shared_ptr<pit::Entry>& entry);
126 
128  void
129  doPropagate(FaceId inFaceId, weak_ptr<pit::Entry> pitEntryWeak);
130 
132  void
133  timeoutOnBestFace(weak_ptr<pit::Entry> pitEntryWeak);
134 
135 protected:
136  static const time::microseconds DEFER_FIRST_WITHOUT_BEST_FACE;
137  static const time::microseconds DEFER_RANGE_WITHOUT_BEST_FACE;
138  static const int UPDATE_MEASUREMENTS_N_LEVELS = 2;
139  static const time::nanoseconds MEASUREMENTS_LIFETIME;
140 };
141 
142 } // namespace fw
143 } // namespace nfd
144 
145 #endif // NFD_DAEMON_FW_NCC_STRATEGY_HPP
static const int ADJUST_PREDICT_UP_SHIFT
Main class of NFD&#39;s forwarding engine.
Definition: forwarder.hpp:51
void timeoutOnBestFace(weak_ptr< pit::Entry > pitEntryWeak)
best face did not reply within prediction
time::microseconds maxInterval
maximum interval between forwarding to two nexthops except best and previous
weak_ptr< Face > bestFace
weak_ptr< Face > previousFace
static constexpr int getTypeId()
Represents a Measurements entry.
static const int UPDATE_MEASUREMENTS_N_LEVELS
time::microseconds prediction
void adjustPredictUp()
#define PUBLIC_WITH_TESTS_ELSE_PROTECTED
Definition: common.hpp:40
scheduler::EventId bestFaceTimeout
timer that expires when best face does not respond within predicted time
static const time::nanoseconds MEASUREMENTS_LIFETIME
StrategyInfo on pit::Entry.
void doPropagate(FaceId inFaceId, weak_ptr< pit::Entry > pitEntryWeak)
propagate to another upstream
shared_ptr< Face > getBestFace()
MeasurementsEntryInfo & getMeasurementsEntryInfo(measurements::Entry *entry)
scheduler::EventId propagateTimer
timer for propagating to another face
void inheritFrom(const MeasurementsEntryInfo &other)
Represents a face-endpoint pair in the forwarder.
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
static const time::microseconds DEFER_RANGE_WITHOUT_BEST_FACE
contains arbitrary information forwarding strategy places on table entries
NccStrategy(Forwarder &forwarder, const Name &name=getStrategyName())
void updateBestFace(const Face &face)
static const time::microseconds MIN_PREDICTION
void afterReceiveInterest(const FaceEndpoint &ingress, const Interest &interest, const shared_ptr< pit::Entry > &pitEntry) override
trigger after Interest is received
MeasurementsEntryInfo()
a forwarding strategy similar to CCNx 0.7.2
static const int ADJUST_PREDICT_DOWN_SHIFT
represents a forwarding strategy
Definition: strategy.hpp:37
static const Name & getStrategyName()
void beforeSatisfyInterest(const shared_ptr< pit::Entry > &pitEntry, const FaceEndpoint &ingress, const Data &data) override
trigger before PIT entry is satisfied
static const time::microseconds INITIAL_PREDICTION
StrategyInfo on measurements::Entry.
static const time::microseconds DEFER_FIRST_WITHOUT_BEST_FACE
static const time::microseconds MAX_PREDICTION
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:44
static constexpr int getTypeId()