blob: 3b7d6b7d526db3f3b0d2ea945a509bcbe9d5b5eb [file] [log] [blame]
Junxiao Shid3c792f2014-01-30 00:46:13 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Alexander Afanasyev9bcbc7c2014-04-06 19:37:37 -07003 * Copyright (c) 2014 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 *
10 * This file is part of NFD (Named Data Networking Forwarding Daemon).
11 * See AUTHORS.md for complete list of NFD authors and contributors.
12 *
13 * NFD is free software: you can redistribute it and/or modify it under the terms
14 * of the GNU General Public License as published by the Free Software Foundation,
15 * either version 3 of the License, or (at your option) any later version.
16 *
17 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
18 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
19 * PURPOSE. See the GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License along with
22 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
23 **/
Junxiao Shid3c792f2014-01-30 00:46:13 -070024
25#ifndef NFD_FW_STRATEGY_HPP
26#define NFD_FW_STRATEGY_HPP
27
Junxiao Shi2d9bdc82014-03-02 20:55:42 -070028#include "forwarder.hpp"
Junxiao Shidbe71732014-02-21 22:23:28 -070029#include "table/measurements-accessor.hpp"
Junxiao Shid3c792f2014-01-30 00:46:13 -070030
31namespace nfd {
Junxiao Shi8c8d2182014-01-30 22:33:00 -070032namespace fw {
33
Junxiao Shibb5105f2014-03-03 12:06:45 -070034/** \brief represents a forwarding strategy
Junxiao Shid3c792f2014-01-30 00:46:13 -070035 */
Junxiao Shibb5105f2014-03-03 12:06:45 -070036class Strategy : public enable_shared_from_this<Strategy>, noncopyable
Junxiao Shid3c792f2014-01-30 00:46:13 -070037{
38public:
Junxiao Shibb5105f2014-03-03 12:06:45 -070039 Strategy(Forwarder& forwarder, const Name& name);
Junxiao Shidbe71732014-02-21 22:23:28 -070040
Junxiao Shid3c792f2014-01-30 00:46:13 -070041 virtual
42 ~Strategy();
Junxiao Shidbe71732014-02-21 22:23:28 -070043
Junxiao Shibb5105f2014-03-03 12:06:45 -070044 /// a Name that represent the Strategy program
45 const Name&
46 getName() const;
47
Junxiao Shi679e9272014-02-15 20:10:21 -070048public: // triggers
49 /** \brief trigger after Interest is received
50 *
51 * The Interest:
52 * - does not violate Scope
53 * - is not looped
54 * - cannot be satisfied by ContentStore
55 * - is under a namespace managed by this strategy
56 *
57 * The strategy should decide whether and where to forward this Interest.
58 * - If the strategy decides to forward this Interest,
59 * invoke this->sendInterest one or more times, either now or shortly after
60 * - If strategy concludes that this Interest cannot be forwarded,
Junxiao Shi09498f02014-02-26 19:41:08 -070061 * invoke this->rejectPendingInterest so that PIT entry will be deleted shortly
Junxiao Shi679e9272014-02-15 20:10:21 -070062 */
Junxiao Shid3c792f2014-01-30 00:46:13 -070063 virtual void
64 afterReceiveInterest(const Face& inFace,
65 const Interest& interest,
66 shared_ptr<fib::Entry> fibEntry,
Junxiao Shi8c8d2182014-01-30 22:33:00 -070067 shared_ptr<pit::Entry> pitEntry) =0;
Junxiao Shidbe71732014-02-21 22:23:28 -070068
Junxiao Shi22be22c2014-02-16 22:53:48 -070069 /** \brief trigger before PIT entry is satisfied
70 *
71 * In this base class this method does nothing.
72 */
73 virtual void
74 beforeSatisfyPendingInterest(shared_ptr<pit::Entry> pitEntry,
75 const Face& inFace, const Data& data);
Junxiao Shidbe71732014-02-21 22:23:28 -070076
Junxiao Shi679e9272014-02-15 20:10:21 -070077 /** \brief trigger before PIT entry expires
78 *
79 * PIT entry expires when InterestLifetime has elapsed for all InRecords,
80 * and it is not satisfied by an incoming Data.
81 *
82 * This trigger is not invoked for PIT entry already satisfied.
83 *
84 * In this base class this method does nothing.
85 */
86 virtual void
87 beforeExpirePendingInterest(shared_ptr<pit::Entry> pitEntry);
Junxiao Shidbe71732014-02-21 22:23:28 -070088
Junxiao Shi22be22c2014-02-16 22:53:48 -070089// /** \brief trigger after FIB entry is being inserted
90// * and becomes managed by this strategy
91// *
92// * In this base class this method does nothing.
93// */
94// virtual void
95// afterAddFibEntry(shared_ptr<fib::Entry> fibEntry);
Junxiao Shidbe71732014-02-21 22:23:28 -070096//
Junxiao Shi22be22c2014-02-16 22:53:48 -070097// /** \brief trigger after FIB entry being managed by this strategy is updated
98// *
99// * In this base class this method does nothing.
100// */
101// virtual void
102// afterUpdateFibEntry(shared_ptr<fib::Entry> fibEntry);
Junxiao Shidbe71732014-02-21 22:23:28 -0700103//
Junxiao Shi22be22c2014-02-16 22:53:48 -0700104// /** \brief trigger before FIB entry ceises to be managed by this strategy
105// * or is being deleted
106// *
107// * In this base class this method does nothing.
108// */
109// virtual void
110// beforeRemoveFibEntry(shared_ptr<fib::Entry> fibEntry);
Junxiao Shidbe71732014-02-21 22:23:28 -0700111
Junxiao Shid3c792f2014-01-30 00:46:13 -0700112protected: // actions
113 /// send Interest to outFace
Junxiao Shi727ed292014-02-19 23:26:45 -0700114 VIRTUAL_WITH_TESTS void
Junxiao Shid3c792f2014-01-30 00:46:13 -0700115 sendInterest(shared_ptr<pit::Entry> pitEntry,
Alexander Afanasyev7e698e62014-03-07 16:48:35 +0000116 shared_ptr<Face> outFace);
Junxiao Shidbe71732014-02-21 22:23:28 -0700117
Junxiao Shid3c792f2014-01-30 00:46:13 -0700118 /** \brief decide that a pending Interest cannot be forwarded
Junxiao Shi679e9272014-02-15 20:10:21 -0700119 *
Junxiao Shid3c792f2014-01-30 00:46:13 -0700120 * This shall not be called if the pending Interest has been
121 * forwarded earlier, and does not need to be resent now.
122 */
Junxiao Shi727ed292014-02-19 23:26:45 -0700123 VIRTUAL_WITH_TESTS void
Junxiao Shi09498f02014-02-26 19:41:08 -0700124 rejectPendingInterest(shared_ptr<pit::Entry> pitEntry);
Junxiao Shidbe71732014-02-21 22:23:28 -0700125
126protected: // accessors
127 MeasurementsAccessor&
128 getMeasurements();
129
Junxiao Shi2d9bdc82014-03-02 20:55:42 -0700130 shared_ptr<Face>
131 getFace(FaceId id);
132
Junxiao Shid3c792f2014-01-30 00:46:13 -0700133private:
Junxiao Shibb5105f2014-03-03 12:06:45 -0700134 Name m_name;
135
Junxiao Shi679e9272014-02-15 20:10:21 -0700136 /** \brief reference to the forwarder
137 *
138 * Triggers can access forwarder indirectly via actions.
139 */
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700140 Forwarder& m_forwarder;
Junxiao Shidbe71732014-02-21 22:23:28 -0700141
142 MeasurementsAccessor m_measurements;
Junxiao Shid3c792f2014-01-30 00:46:13 -0700143};
144
Junxiao Shibb5105f2014-03-03 12:06:45 -0700145inline const Name&
146Strategy::getName() const
147{
148 return m_name;
149}
150
Junxiao Shi2d9bdc82014-03-02 20:55:42 -0700151inline void
152Strategy::sendInterest(shared_ptr<pit::Entry> pitEntry,
153 shared_ptr<Face> outFace)
154{
155 m_forwarder.onOutgoingInterest(pitEntry, *outFace);
156}
157
158inline void
159Strategy::rejectPendingInterest(shared_ptr<pit::Entry> pitEntry)
160{
161 m_forwarder.onInterestReject(pitEntry);
162}
163
Junxiao Shidbe71732014-02-21 22:23:28 -0700164inline MeasurementsAccessor&
165Strategy::getMeasurements()
166{
167 return m_measurements;
168}
169
Junxiao Shi2d9bdc82014-03-02 20:55:42 -0700170inline shared_ptr<Face>
171Strategy::getFace(FaceId id)
172{
173 return m_forwarder.getFace(id);
174}
175
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700176} // namespace fw
Junxiao Shid3c792f2014-01-30 00:46:13 -0700177} // namespace nfd
178
179#endif // NFD_FW_STRATEGY_HPP