Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /** |
Alexander Afanasyev | 9bcbc7c | 2014-04-06 19:37:37 -0700 | [diff] [blame] | 3 | * 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 Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 24 | |
Alexander Afanasyev | 613e2a9 | 2014-04-15 13:36:58 -0700 | [diff] [blame] | 25 | #ifndef NFD_DAEMON_TABLE_PIT_ENTRY_HPP |
| 26 | #define NFD_DAEMON_TABLE_PIT_ENTRY_HPP |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 27 | |
| 28 | #include "pit-in-record.hpp" |
| 29 | #include "pit-out-record.hpp" |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 30 | #include "core/scheduler.hpp" |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 31 | |
Alexander Afanasyev | 18bbf81 | 2014-01-29 01:40:23 -0800 | [diff] [blame] | 32 | namespace nfd { |
HangZhang | cb4fc83 | 2014-03-11 16:57:11 +0800 | [diff] [blame] | 33 | |
| 34 | class NameTree; |
| 35 | |
| 36 | namespace name_tree { |
| 37 | class Entry; |
| 38 | } |
| 39 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 40 | namespace pit { |
| 41 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 42 | /** \brief represents an unordered collection of InRecords |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 43 | */ |
| 44 | typedef std::list< InRecord> InRecordCollection; |
| 45 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 46 | /** \brief represents an unordered collection of OutRecords |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 47 | */ |
| 48 | typedef std::list<OutRecord> OutRecordCollection; |
| 49 | |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 50 | /** \brief represents a PIT entry |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 51 | */ |
Junxiao Shi | 408a700 | 2014-02-12 17:53:47 -0700 | [diff] [blame] | 52 | class Entry : public StrategyInfoHost, noncopyable |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 53 | { |
| 54 | public: |
| 55 | explicit |
| 56 | Entry(const Interest& interest); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 57 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 58 | const Interest& |
| 59 | getInterest() const; |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 60 | |
| 61 | /** \return Interest Name |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 62 | */ |
| 63 | const Name& |
| 64 | getName() const; |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 65 | |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 66 | /** \brief decides whether Interest can be forwarded to face |
| 67 | * |
| 68 | * \return true if OutRecord of this face does not exist or has expired, |
Junxiao Shi | 57f0f31 | 2014-03-16 11:52:20 -0700 | [diff] [blame] | 69 | * and there is an InRecord not of this face, |
| 70 | * and scope is not violated |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 71 | */ |
| 72 | bool |
Junxiao Shi | 57f0f31 | 2014-03-16 11:52:20 -0700 | [diff] [blame] | 73 | canForwardTo(const Face& face) const; |
| 74 | |
| 75 | /** \brief decides whether forwarding Interest to face would violate scope |
| 76 | * |
| 77 | * \return true if scope control would be violated |
| 78 | * \note canForwardTo has more comprehensive checks (including scope control) |
| 79 | * and should be used by most strategies. Outgoing Interest pipeline |
| 80 | * should only check scope because some strategy (eg. vehicular) needs |
| 81 | * to retransmit sooner than OutRecord expiry, or forward Interest |
| 82 | * back to incoming face |
| 83 | */ |
| 84 | bool |
| 85 | violatesScope(const Face& face) const; |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 86 | |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 87 | /** \brief records a nonce |
| 88 | * |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 89 | * \return true if nonce is new; false if nonce is seen before |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 90 | */ |
| 91 | bool |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 92 | addNonce(uint32_t nonce); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 93 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 94 | public: // InRecord |
| 95 | const InRecordCollection& |
| 96 | getInRecords() const; |
| 97 | |
| 98 | /** \brief determines whether any InRecord is a local Face |
| 99 | * |
| 100 | * \return true if any InRecord is a local Face, |
| 101 | * false if all InRecords are non-local Faces |
| 102 | */ |
| 103 | bool |
| 104 | hasLocalInRecord() const; |
| 105 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 106 | /** \brief inserts a InRecord for face, and updates it with interest |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 107 | * |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 108 | * If InRecord for face exists, the existing one is updated. |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 109 | * This method does not add the Nonce as a seen Nonce. |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 110 | * \return an iterator to the InRecord |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 111 | */ |
| 112 | InRecordCollection::iterator |
| 113 | insertOrUpdateInRecord(shared_ptr<Face> face, const Interest& interest); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 114 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 115 | /** \brief get the InRecord for face |
| 116 | * \return an iterator to the InRecord, or .end if it does not exist |
| 117 | */ |
| 118 | InRecordCollection::const_iterator |
| 119 | getInRecord(shared_ptr<Face> face) const; |
| 120 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 121 | /// deletes all InRecords |
| 122 | void |
| 123 | deleteInRecords(); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 124 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 125 | public: // OutRecord |
| 126 | const OutRecordCollection& |
| 127 | getOutRecords() const; |
| 128 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 129 | /** \brief inserts a OutRecord for face, and updates it with interest |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 130 | * |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 131 | * If OutRecord for face exists, the existing one is updated. |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 132 | * \return an iterator to the OutRecord |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 133 | */ |
| 134 | OutRecordCollection::iterator |
| 135 | insertOrUpdateOutRecord(shared_ptr<Face> face, const Interest& interest); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 136 | |
Junxiao Shi | 66f91f8 | 2014-05-10 17:28:58 -0700 | [diff] [blame^] | 137 | /** \brief get the OutRecord for face |
| 138 | * \return an iterator to the OutRecord, or .end if it does not exist |
| 139 | */ |
| 140 | OutRecordCollection::const_iterator |
| 141 | getOutRecord(shared_ptr<Face> face) const; |
| 142 | |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 143 | /// deletes one OutRecord for face if exists |
| 144 | void |
| 145 | deleteOutRecord(shared_ptr<Face> face); |
Junxiao Shi | 0b5fbbb | 2014-02-20 15:54:03 -0700 | [diff] [blame] | 146 | |
Junxiao Shi | 57f0f31 | 2014-03-16 11:52:20 -0700 | [diff] [blame] | 147 | /** \return true if there is one or more unexpired OutRecords |
| 148 | */ |
| 149 | bool |
| 150 | hasUnexpiredOutRecords() const; |
| 151 | |
Junxiao Shi | d3c792f | 2014-01-30 00:46:13 -0700 | [diff] [blame] | 152 | public: |
| 153 | EventId m_unsatisfyTimer; |
| 154 | EventId m_stragglerTimer; |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 155 | |
| 156 | private: |
| 157 | std::set<uint32_t> m_nonces; |
| 158 | const Interest m_interest; |
| 159 | InRecordCollection m_inRecords; |
| 160 | OutRecordCollection m_outRecords; |
Junxiao Shi | 57f0f31 | 2014-03-16 11:52:20 -0700 | [diff] [blame] | 161 | |
| 162 | static const Name LOCALHOST_NAME; |
| 163 | static const Name LOCALHOP_NAME; |
| 164 | |
HangZhang | cb4fc83 | 2014-03-11 16:57:11 +0800 | [diff] [blame] | 165 | shared_ptr<name_tree::Entry> m_nameTreeEntry; |
| 166 | |
| 167 | friend class nfd::NameTree; |
| 168 | friend class nfd::name_tree::Entry; |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 169 | }; |
| 170 | |
| 171 | inline const Interest& |
| 172 | Entry::getInterest() const |
| 173 | { |
| 174 | return m_interest; |
| 175 | } |
| 176 | |
| 177 | } // namespace pit |
Alexander Afanasyev | 18bbf81 | 2014-01-29 01:40:23 -0800 | [diff] [blame] | 178 | } // namespace nfd |
Junxiao Shi | cbba04c | 2014-01-26 14:21:22 -0700 | [diff] [blame] | 179 | |
Alexander Afanasyev | 613e2a9 | 2014-04-15 13:36:58 -0700 | [diff] [blame] | 180 | #endif // NFD_DAEMON_TABLE_PIT_ENTRY_HPP |