Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 1 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */ |
| 2 | /* |
| 3 | * Copyright (c) 2011 University of California, Los Angeles |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
| 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 19 | */ |
| 20 | |
| 21 | #ifndef _CCNX_PIT_ENTRY_H_ |
| 22 | #define _CCNX_PIT_ENTRY_H_ |
| 23 | |
| 24 | #include "ns3/ptr.h" |
| 25 | |
| 26 | #include "ccnx-pit-entry-incoming-face.h" |
| 27 | #include "ccnx-pit-entry-outgoing-face.h" |
| 28 | #include "ccnx-fib.h" |
| 29 | |
| 30 | #include <boost/multi_index_container.hpp> |
| 31 | #include <boost/multi_index/tag.hpp> |
| 32 | #include <boost/multi_index/ordered_index.hpp> |
| 33 | #include <boost/multi_index/composite_key.hpp> |
| 34 | #include <boost/multi_index/hashed_index.hpp> |
| 35 | #include <boost/multi_index/member.hpp> |
| 36 | #include <boost/multi_index/mem_fun.hpp> |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 37 | #include <set> |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 38 | |
| 39 | #include <iostream> |
| 40 | |
| 41 | namespace ns3 { |
| 42 | |
| 43 | class CcnxFace; |
| 44 | class CcnxNameComponents; |
| 45 | |
| 46 | namespace __ccnx_private |
| 47 | { |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 48 | // class i_face {}; |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 49 | } |
| 50 | |
| 51 | /** |
| 52 | * \ingroup ccnx |
| 53 | * \brief Typedef for indexed face container of CcnxPitEntryIncomingFace |
| 54 | * |
| 55 | * Indexes: |
| 56 | * - by face (may be it will be possible to replace with just the std::map) |
| 57 | */ |
| 58 | struct CcnxPitEntryIncomingFaceContainer |
| 59 | { |
| 60 | typedef boost::multi_index::multi_index_container< |
| 61 | CcnxPitEntryIncomingFace, |
| 62 | boost::multi_index::indexed_by< |
| 63 | // For fast access to elements using CcnxFace |
| 64 | boost::multi_index::ordered_unique< |
| 65 | boost::multi_index::tag<__ccnx_private::i_face>, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 66 | boost::multi_index::member<CcnxPitEntryIncomingFace, Ptr<CcnxFace>, &CcnxPitEntryIncomingFace::m_face> |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 67 | > |
| 68 | > |
| 69 | > type; |
| 70 | }; |
| 71 | |
| 72 | /** |
| 73 | * \ingroup ccnx |
| 74 | * \brief Typedef for indexed face container of CcnxPitEntryOutgoingFace |
| 75 | * |
| 76 | * Indexes: |
| 77 | * - by face (may be it will be possible to replace with just the std::map) |
| 78 | */ |
| 79 | struct CcnxPitEntryOutgoingFaceContainer |
| 80 | { |
| 81 | typedef boost::multi_index::multi_index_container< |
| 82 | CcnxPitEntryOutgoingFace, |
| 83 | boost::multi_index::indexed_by< |
| 84 | // For fast access to elements using CcnxFace |
| 85 | boost::multi_index::ordered_unique< |
| 86 | boost::multi_index::tag<__ccnx_private::i_face>, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 87 | boost::multi_index::member<CcnxPitEntryOutgoingFace, Ptr<CcnxFace>, &CcnxPitEntryOutgoingFace::m_face> |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 88 | > |
| 89 | > |
| 90 | > type; |
| 91 | }; |
| 92 | |
| 93 | |
| 94 | /** |
| 95 | * \ingroup ccnx |
| 96 | * \brief structure for PIT entry |
| 97 | */ |
| 98 | struct CcnxPitEntry |
| 99 | { |
| 100 | public: |
| 101 | /** |
| 102 | * \brief PIT entry constructor |
| 103 | * \param prefix Prefix of the PIT entry |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 104 | * \param fibEntry A FIB entry associated with the PIT entry |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 105 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 106 | CcnxPitEntry (Ptr<CcnxNameComponents> prefix, const Time &expireTime, const CcnxFibEntry &fibEntry); |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 107 | |
| 108 | // // Get number of outgoing interests that we're expecting data from |
| 109 | // inline size_t numberOfPromisingInterests( ) const; |
| 110 | |
Alexander Afanasyev | 19426ef | 2011-11-23 20:55:28 -0800 | [diff] [blame] | 111 | const CcnxNameComponents & |
| 112 | GetPrefix () const |
| 113 | { |
| 114 | return *m_prefix; |
| 115 | } |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 116 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 117 | /** |
| 118 | * @brief Get current expiration time of the record |
| 119 | * |
| 120 | * @returns current expiration time of the record |
| 121 | */ |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 122 | const Time & |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 123 | GetExpireTime () const |
| 124 | { return m_expireTime; } |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 125 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 126 | /** |
| 127 | * @brief Set expiration time on record as `expireTime` (absolute time) |
| 128 | * |
| 129 | * @param expireTime absolute simulation time of when the record should expire |
| 130 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 131 | void |
| 132 | SetExpireTime (const Time &expireTime) |
| 133 | { |
| 134 | m_expireTime = expireTime; |
| 135 | } |
| 136 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 137 | /** |
| 138 | * @brief Check if nonce `nonce` for the same prefix has already been seen |
| 139 | * |
| 140 | * @param nonce Nonce to check |
| 141 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 142 | bool |
| 143 | IsNonceSeen (uint32_t nonce) const |
| 144 | { return m_seenNonces.find (nonce) != m_seenNonces.end (); } |
| 145 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 146 | /** |
| 147 | * @brief Add `nonce` to the list of seen nonces |
| 148 | * |
| 149 | * @param nonce nonce to add to the list of seen nonces |
| 150 | * |
| 151 | * All nonces are stored for the lifetime of the PIT entry |
| 152 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 153 | void |
| 154 | AddSeenNonce (uint32_t nonce) |
| 155 | { m_seenNonces.insert (nonce); } |
| 156 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 157 | /** |
| 158 | * @brief Add `face` to the list of incoming faces |
| 159 | * |
| 160 | * @param face Face to add to the list of incoming faces |
| 161 | * @returns iterator to the added entry |
| 162 | */ |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 163 | CcnxPitEntryIncomingFaceContainer::type::iterator |
| 164 | AddIncoming (Ptr<CcnxFace> face); |
| 165 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 166 | /** |
Alexander Afanasyev | 9d313d4 | 2011-11-25 13:36:15 -0800 | [diff] [blame^] | 167 | * @brief Remove incoming entry for face `face` |
| 168 | */ |
| 169 | void |
| 170 | RemoveIncoming (Ptr<CcnxFace> face); |
| 171 | |
| 172 | /** |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 173 | * @brief Clear all incoming faces either after all of them were satisfied or NACKed |
| 174 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 175 | void |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 176 | ClearIncoming () |
| 177 | { m_incoming.clear (); } |
| 178 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 179 | /** |
| 180 | * @brief Add `face` to the list of outgoing faces |
| 181 | * |
| 182 | * @param face Face to add to the list of outgoing faces |
| 183 | * @returns iterator to the added entry |
| 184 | */ |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 185 | CcnxPitEntryOutgoingFaceContainer::type::iterator |
| 186 | AddOutgoing (Ptr<CcnxFace> face); |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 187 | |
| 188 | /** |
| 189 | * @brief Remove all references to face. |
| 190 | * |
| 191 | * This method should be called before face is completely removed from the stack. |
| 192 | * Face is removed from the lists of incoming and outgoing faces |
| 193 | */ |
| 194 | void |
| 195 | RemoveAllReferencesToFace (Ptr<CcnxFace> face); |
| 196 | |
| 197 | protected: |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 198 | |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 199 | private: |
| 200 | friend std::ostream& operator<< (std::ostream& os, const CcnxPitEntry &entry); |
| 201 | |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 202 | public: |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 203 | Ptr<CcnxNameComponents> m_prefix; ///< \brief Prefix of the PIT entry |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 204 | const CcnxFibEntry &m_fibEntry; ///< \brief FIB entry related to this prefix |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 205 | std::set<uint32_t> m_seenNonces; ///< \brief map of nonces that were seen for this prefix |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 206 | |
| 207 | CcnxPitEntryIncomingFaceContainer::type m_incoming; ///< \brief container for incoming interests |
| 208 | CcnxPitEntryOutgoingFaceContainer::type m_outgoing; ///< \brief container for outgoing interests |
| 209 | |
| 210 | Time m_expireTime; ///< \brief Time when PIT entry will be removed |
| 211 | bool m_timerExpired; ///< \brief flag indicating that PIT timer has expired |
| 212 | int m_counterExpirations; ///< \brief whether timer is expired (+ number of times timer expired) |
| 213 | }; |
| 214 | |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 215 | } // namespace ns3 |
| 216 | |
| 217 | #endif // _CCNX_PIT_ENTRY_H_ |