/
pit-entry.hpp
252 lines (215 loc) · 6.8 KB
/
pit-entry.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
* Copyright (c) 2014-2016, Regents of the University of California,
* Arizona Board of Regents,
* Colorado State University,
* University Pierre & Marie Curie, Sorbonne University,
* Washington University in St. Louis,
* Beijing Institute of Technology,
* The University of Memphis.
*
* This file is part of NFD (Named Data Networking Forwarding Daemon).
* See AUTHORS.md for complete list of NFD authors and contributors.
*
* NFD is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Foundation,
* either version 3 of the License, or (at your option) any later version.
*
* NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef NFD_DAEMON_TABLE_PIT_ENTRY_HPP
#define NFD_DAEMON_TABLE_PIT_ENTRY_HPP
#include "pit-in-record.hpp"
#include "pit-out-record.hpp"
#include "core/scheduler.hpp"
namespace nfd {
namespace name_tree {
class Entry;
} // namespace name_tree
namespace pit {
/** \brief an unordered collection of in-records
*/
typedef std::list<InRecord> InRecordCollection;
/** \brief an unordered collection of out-records
*/
typedef std::list<OutRecord> OutRecordCollection;
/** \brief an Interest table entry
*
* An Interest table entry represents either a pending Interest or a recently satisfied Interest.
* Each entry contains a collection of in-records, a collection of out-records,
* and two timers used in forwarding pipelines.
* In addition, the entry, in-records, and out-records are subclasses of StrategyInfoHost,
* which allows forwarding strategy to store arbitrary information on them.
*/
class Entry : public StrategyInfoHost, noncopyable
{
public:
explicit
Entry(const Interest& interest);
/** \return the representative Interest of the PIT entry
* \note Every Interest in in-records and out-records should have same Name and Selectors
* as the representative Interest.
* \todo #3162 require Link field to match the representative Interest
*/
const Interest&
getInterest() const
{
return *m_interest;
}
/** \return Interest Name
*/
const Name&
getName() const
{
return m_interest->getName();
}
/** \return whether interest matches this entry
* \param interest the Interest
* \param nEqualNameComps number of initial name components guaranteed to be equal
*/
bool
canMatch(const Interest& interest, size_t nEqualNameComps = 0) const;
public: // in-record
/** \return collection of in-records
*/
const InRecordCollection&
getInRecords() const
{
return m_inRecords;
}
/** \retval true There is at least one in-record.
* This implies some downstream is waiting for Data or Nack.
* \retval false There is no in-record.
* This implies the entry is new or has been satisfied or Nacked.
*/
bool
hasInRecords() const
{
return !m_inRecords.empty();
}
InRecordCollection::iterator
in_begin()
{
return m_inRecords.begin();
}
InRecordCollection::const_iterator
in_begin() const
{
return m_inRecords.begin();
}
InRecordCollection::iterator
in_end()
{
return m_inRecords.end();
}
InRecordCollection::const_iterator
in_end() const
{
return m_inRecords.end();
}
/** \brief get the in-record for \p face
* \return an iterator to the in-record, or .in_end() if it does not exist
*/
InRecordCollection::iterator
getInRecord(const Face& face);
/** \brief insert or update an in-record
* \return an iterator to the new or updated in-record
*/
InRecordCollection::iterator
insertOrUpdateInRecord(Face& face, const Interest& interest);
/** \brief delete the in-record for \p face if it exists
*/
void
deleteInRecord(const Face& face);
/** \brief delete all in-records
*/
void
clearInRecords();
public: // out-record
/** \return collection of in-records
*/
const OutRecordCollection&
getOutRecords() const
{
return m_outRecords;
}
/** \retval true There is at least one out-record.
* This implies the Interest has been forwarded to some upstream,
* and they haven't returned Data, but may have returned Nacks.
* \retval false There is no out-record.
* This implies the Interest has not been forwarded.
*/
bool
hasOutRecords() const
{
return !m_outRecords.empty();
}
OutRecordCollection::iterator
out_begin()
{
return m_outRecords.begin();
}
OutRecordCollection::const_iterator
out_begin() const
{
return m_outRecords.begin();
}
OutRecordCollection::iterator
out_end()
{
return m_outRecords.end();
}
OutRecordCollection::const_iterator
out_end() const
{
return m_outRecords.end();
}
/** \brief get the out-record for \p face
* \return an iterator to the out-record, or .out_end() if it does not exist
*/
OutRecordCollection::iterator
getOutRecord(const Face& face);
/** \brief insert or update an out-record
* \return an iterator to the new or updated out-record
*/
OutRecordCollection::iterator
insertOrUpdateOutRecord(Face& face, const Interest& interest);
/** \brief delete the out-record for \p face if it exists
*/
void
deleteOutRecord(const Face& face);
public:
/** \brief unsatisfy timer
*
* This timer is used in forwarding pipelines to delete the entry
* when it expires without being satisfied.
* It fires when the last InterestLifetime among in-records expires.
*
* Either this or the straggler timer should be set at all times,
* except when this entry is being processed in a pipeline.
*/
scheduler::EventId m_unsatisfyTimer;
/** \brief straggler timer
*
* This timer is used in forwarding pipelines to delete the entry when it has been satisfied
* and is no longer needed for measurement collection purpose.
*
* Either this or the unsatisfy timer should be set at all times,
* except when this entry is being processed in a pipeline.
*/
scheduler::EventId m_stragglerTimer;
private:
shared_ptr<const Interest> m_interest;
InRecordCollection m_inRecords;
OutRecordCollection m_outRecords;
name_tree::Entry* m_nameTreeEntry;
friend class name_tree::Entry;
};
} // namespace pit
} // namespace nfd
#endif // NFD_DAEMON_TABLE_PIT_ENTRY_HPP