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