Jeff Thompson | 25b4e61 | 2013-10-10 16:03:24 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 2 | /** |
Jeff Thompson | 7687dc0 | 2013-09-13 11:54:07 -0700 | [diff] [blame] | 3 | * Copyright (C) 2013 Regents of the University of California. |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 4 | * See COPYING for copyright and distribution information. |
| 5 | */ |
| 6 | |
Jeff Thompson | b9e3c8e | 2013-08-02 11:42:51 -0700 | [diff] [blame] | 7 | #ifndef NDN_FACE_HPP |
Jeff Thompson | a0d18c9 | 2013-08-06 13:55:32 -0700 | [diff] [blame] | 8 | #define NDN_FACE_HPP |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 9 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 10 | #include "common.hpp" |
| 11 | #include "interest.hpp" |
| 12 | #include "data.hpp" |
| 13 | |
Alexander Afanasyev | e2e0d75 | 2014-01-03 13:30:30 -0800 | [diff] [blame] | 14 | #include "transport/transport.hpp" |
| 15 | #include "transport/unix-transport.hpp" |
Alexander Afanasyev | 20d2c58 | 2014-01-26 15:32:51 -0800 | [diff] [blame] | 16 | #include "transport/tcp-transport.hpp" |
Jeff Thompson | beb8b7d | 2013-07-16 15:49:21 -0700 | [diff] [blame] | 17 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 18 | #include "management/controller.hpp" |
| 19 | |
| 20 | #include "detail/registered-prefix.hpp" |
| 21 | #include "detail/pending-interest.hpp" |
| 22 | |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 23 | namespace ndn { |
| 24 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 25 | struct PendingInterestId; |
| 26 | struct RegisteredPrefixId; |
| 27 | |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 28 | /** |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 29 | * An OnData function object is used to pass a callback to expressInterest. |
| 30 | */ |
| 31 | typedef function<void(const Interest&, Data&)> OnData; |
| 32 | |
| 33 | /** |
| 34 | * An OnTimeout function object is used to pass a callback to expressInterest. |
| 35 | */ |
| 36 | typedef function<void(const Interest&)> OnTimeout; |
| 37 | |
| 38 | /** |
| 39 | * An OnInterest function object is used to pass a callback to registerPrefix. |
| 40 | */ |
| 41 | typedef function<void (const Name&, const Interest&)> OnInterest; |
| 42 | |
| 43 | /** |
| 44 | * An OnRegisterFailed function object is used to report when registerPrefix fails. |
| 45 | */ |
| 46 | typedef function<void(const Name&, const std::string&)> OnSetInterestFilterFailed; |
| 47 | |
| 48 | |
| 49 | |
| 50 | /** |
| 51 | * @brief Abstraction to communicate with local or remote NDN forwarder |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 52 | */ |
Alexander Afanasyev | 8460afb | 2014-02-15 20:31:42 -0800 | [diff] [blame] | 53 | class Face : noncopyable |
| 54 | { |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 55 | public: |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 56 | struct Error : public std::runtime_error { Error(const std::string &what) : std::runtime_error(what) {} }; |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 57 | |
| 58 | /** |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 59 | * @brief Create a new Face for communication with an NDN Forwarder using the default UnixTransport. |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 60 | */ |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 61 | Face(); |
Alexander Afanasyev | e2e0d75 | 2014-01-03 13:30:30 -0800 | [diff] [blame] | 62 | |
| 63 | /** |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 64 | * @brief Create a new Face for communication with an NDN Forwarder using the default UnixTransport. |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 65 | * @param ioService A shared pointer to boost::io_service object that should control all IO operations |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 66 | */ |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 67 | explicit |
| 68 | Face(const ptr_lib::shared_ptr<boost::asio::io_service> &ioService); |
Jeff Thompson | b982b6d | 2013-07-15 18:15:45 -0700 | [diff] [blame] | 69 | |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 70 | /** |
Jeff Thompson | 86507bc | 2013-08-23 20:51:38 -0700 | [diff] [blame] | 71 | * Create a new Face for communication with an NDN hub at host:port using the default TcpTransport. |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 72 | * @param host The host of the NDN hub. |
Alexander Afanasyev | 20d2c58 | 2014-01-26 15:32:51 -0800 | [diff] [blame] | 73 | * @param port The port or service name of the NDN hub. If omitted. use 6363. |
Jeff Thompson | fe08e5a | 2013-08-13 11:15:59 -0700 | [diff] [blame] | 74 | */ |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 75 | Face(const std::string &host, const std::string &port = "6363"); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 76 | |
| 77 | /** |
| 78 | * Create a new Face for communication with an NDN hub with the given Transport object and connectionInfo. |
| 79 | * @param transport A shared_ptr to a Transport object used for communication. |
| 80 | * @param transport A shared_ptr to a Transport::ConnectionInfo to be used to connect to the transport. |
| 81 | */ |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 82 | explicit |
| 83 | Face(const shared_ptr<Transport>& transport); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 84 | |
| 85 | /** |
| 86 | * @brief Alternative (special use case) version of the constructor, can be used to aggregate |
| 87 | * several Faces within one processing thread |
| 88 | * |
| 89 | * <code> |
| 90 | * Face face1(...); |
| 91 | * Face face2(..., face1.getAsyncService()); |
| 92 | * |
| 93 | * // Now the following ensures that events on both faces are processed |
| 94 | * face1.processEvents(); |
| 95 | * </code> |
| 96 | */ |
| 97 | Face(const shared_ptr<Transport>& transport, |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 98 | const shared_ptr<boost::asio::io_service> &ioService); |
Alexander Afanasyev | 20d2c58 | 2014-01-26 15:32:51 -0800 | [diff] [blame] | 99 | |
Jeff Thompson | 4fe4551 | 2013-08-23 14:06:38 -0700 | [diff] [blame] | 100 | /** |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 101 | * @brief Express Interest |
| 102 | * |
| 103 | * @param interest A reference to the Interest. This copies the Interest. |
| 104 | * @param onData A function object to call when a matching data packet is received. |
| 105 | * @param onTimeout A function object to call if the interest times out. |
| 106 | * If onTimeout is an empty OnTimeout(), this does not use it. |
| 107 | * |
Jeff Thompson | 1109514 | 2013-10-01 16:20:28 -0700 | [diff] [blame] | 108 | * @return The pending interest ID which can be used with removePendingInterest. |
Jeff Thompson | 4fe4551 | 2013-08-23 14:06:38 -0700 | [diff] [blame] | 109 | */ |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 110 | const PendingInterestId* |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 111 | expressInterest(const Interest& interest, |
| 112 | const OnData& onData, const OnTimeout& onTimeout = OnTimeout()); |
Jeff Thompson | 4fe4551 | 2013-08-23 14:06:38 -0700 | [diff] [blame] | 113 | |
| 114 | /** |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 115 | * @brief Express Interest using name and Interest template |
| 116 | * |
| 117 | * @param name Name of the Interest |
| 118 | * @param tmpl Interest template to fill parameters |
| 119 | * @param onData A callback to call when a matching data packet is received. |
| 120 | * @param onTimeout A callback to call if the interest times out. |
| 121 | * If onTimeout is an empty OnTimeout(), this does not use it. |
| 122 | * |
Jeff Thompson | 1109514 | 2013-10-01 16:20:28 -0700 | [diff] [blame] | 123 | * @return The pending interest ID which can be used with removePendingInterest. |
Jeff Thompson | 7aec025 | 2013-08-22 17:29:57 -0700 | [diff] [blame] | 124 | */ |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 125 | const PendingInterestId* |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 126 | expressInterest(const Name& name, |
| 127 | const Interest &tmpl, |
| 128 | const OnData& onData, const OnTimeout& onTimeout = OnTimeout()); |
| 129 | |
Jeff Thompson | 1109514 | 2013-10-01 16:20:28 -0700 | [diff] [blame] | 130 | /** |
| 131 | * Remove the pending interest entry with the pendingInterestId from the pending interest table. |
| 132 | * This does not affect another pending interest with a different pendingInterestId, even it if has the same interest name. |
| 133 | * If there is no entry with the pendingInterestId, do nothing. |
| 134 | * @param pendingInterestId The ID returned from expressInterest. |
| 135 | */ |
| 136 | void |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 137 | removePendingInterest(const PendingInterestId *pendingInterestId); |
Jeff Thompson | cdf7e25 | 2013-07-31 12:41:47 -0700 | [diff] [blame] | 138 | |
Jeff Thompson | 432c8be | 2013-08-09 16:16:08 -0700 | [diff] [blame] | 139 | /** |
Jeff Thompson | 86507bc | 2013-08-23 20:51:38 -0700 | [diff] [blame] | 140 | * Register prefix with the connected NDN hub and call onInterest when a matching interest is received. |
| 141 | * @param prefix A reference to a Name for the prefix to register. This copies the Name. |
| 142 | * @param onInterest A function object to call when a matching interest is received. This copies the function object, so you may need to |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 143 | * use ref() as appropriate. |
Jeff Thompson | 590ec23 | 2013-09-18 15:55:56 -0700 | [diff] [blame] | 144 | * @param onRegisterFailed A function object to call if failed to retrieve the connected hub’s ID or failed to register the prefix. |
| 145 | * This calls onRegisterFailed(prefix) where prefix is the prefix given to registerPrefix. |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 146 | * @param flags The flags for finer control of which interests are forward to the application. |
Jeff Thompson | 1109514 | 2013-10-01 16:20:28 -0700 | [diff] [blame] | 147 | * @return The registered prefix ID which can be used with removeRegisteredPrefix. |
Jeff Thompson | 86507bc | 2013-08-23 20:51:38 -0700 | [diff] [blame] | 148 | */ |
Alexander Afanasyev | b790d95 | 2014-01-24 12:07:53 -0800 | [diff] [blame] | 149 | const RegisteredPrefixId* |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 150 | setInterestFilter(const Name& prefix, |
| 151 | const OnInterest& onInterest, |
| 152 | const OnSetInterestFilterFailed& onSetInterestFilterFailed); |
Jeff Thompson | 1109514 | 2013-10-01 16:20:28 -0700 | [diff] [blame] | 153 | |
| 154 | /** |
| 155 | * Remove the registered prefix entry with the registeredPrefixId from the pending interest table. |
| 156 | * This does not affect another registered prefix with a different registeredPrefixId, even it if has the same prefix name. |
| 157 | * If there is no entry with the registeredPrefixId, do nothing. |
| 158 | * @param registeredPrefixId The ID returned from registerPrefix. |
| 159 | */ |
| 160 | void |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 161 | unsetInterestFilter(const RegisteredPrefixId *registeredPrefixId); |
Alexander Afanasyev | a557d5a | 2013-12-28 21:59:03 -0800 | [diff] [blame] | 162 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 163 | /** |
Alexander Afanasyev | a557d5a | 2013-12-28 21:59:03 -0800 | [diff] [blame] | 164 | * @brief Publish data packet |
| 165 | * |
| 166 | * This method can be called to satisfy the incoming Interest or to put Data packet into the cache |
| 167 | * of the local NDN forwarder |
| 168 | */ |
| 169 | void |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 170 | put(const Data &data); |
| 171 | |
Jeff Thompson | 86507bc | 2013-08-23 20:51:38 -0700 | [diff] [blame] | 172 | /** |
Jeff Thompson | bf50a1a | 2013-08-20 18:01:01 -0700 | [diff] [blame] | 173 | * Process any data to receive or call timeout callbacks. |
Alexander Afanasyev | a557d5a | 2013-12-28 21:59:03 -0800 | [diff] [blame] | 174 | * |
| 175 | * This call will block forever (default timeout == 0) to process IO on the face. |
| 176 | * To exit, one expected to call face.shutdown() from one of the callback methods. |
| 177 | * |
Alexander Afanasyev | f75a0aa | 2014-01-09 14:29:22 -0800 | [diff] [blame] | 178 | * If positive timeout is specified, then processEvents will exit after this timeout, |
| 179 | * if not stopped earlier with face.shutdown() or when all active events finish. |
Alexander Afanasyev | a557d5a | 2013-12-28 21:59:03 -0800 | [diff] [blame] | 180 | * The call can be called repeatedly, if desired. |
| 181 | * |
Alexander Afanasyev | f75a0aa | 2014-01-09 14:29:22 -0800 | [diff] [blame] | 182 | * If negative timeout is specified, then processEvents will not block and process only pending |
| 183 | * events. |
| 184 | * |
Jeff Thompson | 432c8be | 2013-08-09 16:16:08 -0700 | [diff] [blame] | 185 | * @throw This may throw an exception for reading data or in the callback for processing the data. If you |
| 186 | * call this from an main event loop, you may want to catch and log/disregard all exceptions. |
| 187 | */ |
Jeff Thompson | 0050abe | 2013-09-17 12:50:25 -0700 | [diff] [blame] | 188 | void |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 189 | processEvents(Milliseconds timeout = 0, bool keepThread = false); |
Jeff Thompson | 432c8be | 2013-08-09 16:16:08 -0700 | [diff] [blame] | 190 | |
Jeff Thompson | 0050abe | 2013-09-17 12:50:25 -0700 | [diff] [blame] | 191 | void |
| 192 | shutdown(); |
Yingdi Yu | 0d92081 | 2014-01-30 14:50:57 -0800 | [diff] [blame] | 193 | |
| 194 | shared_ptr<boost::asio::io_service> |
Alexander Afanasyev | f39c537 | 2014-02-17 19:42:56 -0800 | [diff] [blame] | 195 | ioService() { return m_ioService; } |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 196 | |
| 197 | private: |
| 198 | void |
Alexander Afanasyev | f7ca320 | 2014-02-14 22:28:31 -0800 | [diff] [blame] | 199 | construct(const shared_ptr<Transport>& transport, const shared_ptr<boost::asio::io_service>& ioService); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 200 | |
| 201 | struct ProcessEventsTimeout {}; |
| 202 | typedef std::list<shared_ptr<PendingInterest> > PendingInterestTable; |
| 203 | typedef std::list<shared_ptr<RegisteredPrefix> > RegisteredPrefixTable; |
| 204 | |
| 205 | void |
Alexander Afanasyev | 6d48bc1 | 2014-02-18 00:10:51 -0800 | [diff] [blame^] | 206 | asyncExpressInterest(const shared_ptr<const Interest>& interest, |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 207 | const OnData& onData, const OnTimeout& onTimeout); |
| 208 | |
| 209 | void |
Alexander Afanasyev | 6d48bc1 | 2014-02-18 00:10:51 -0800 | [diff] [blame^] | 210 | asyncRemovePendingInterest(const PendingInterestId* pendingInterestId); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 211 | |
| 212 | void |
Alexander Afanasyev | 6d48bc1 | 2014-02-18 00:10:51 -0800 | [diff] [blame^] | 213 | asyncUnsetInterestFilter(const RegisteredPrefixId* registeredPrefixId); |
Alexander Afanasyev | 12dfbad | 2014-02-11 14:42:46 -0800 | [diff] [blame] | 214 | |
| 215 | void |
| 216 | finalizeUnsertInterestFilter(RegisteredPrefixTable::iterator item); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 217 | |
| 218 | void |
Alexander Afanasyev | 6d48bc1 | 2014-02-18 00:10:51 -0800 | [diff] [blame^] | 219 | onReceiveElement(const Block& wire); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 220 | |
| 221 | |
| 222 | static void |
| 223 | fireProcessEventsTimeout(const boost::system::error_code& error); |
| 224 | |
| 225 | /** |
| 226 | * Find the entry from the pit_ where the name conforms to the entry's interest selectors, and |
| 227 | * the entry interest name is the longest that matches name. |
| 228 | * @param name The name to find the interest for (from the incoming data packet). |
| 229 | * @return The index in pit_ of the pit entry, or -1 if not found. |
| 230 | */ |
| 231 | PendingInterestTable::iterator |
| 232 | getEntryIndexForExpressedInterest(const Name& name); |
| 233 | |
| 234 | /** |
Alexander Afanasyev | f39c537 | 2014-02-17 19:42:56 -0800 | [diff] [blame] | 235 | * Find the first entry from the m_registeredPrefixTable where the entry prefix is the longest that matches name. |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 236 | * @param name The name to find the PrefixEntry for (from the incoming interest packet). |
| 237 | * @return A pointer to the entry, or 0 if not found. |
| 238 | */ |
| 239 | RegisteredPrefixTable::iterator |
| 240 | getEntryForRegisteredPrefix(const Name& name); |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 241 | |
| 242 | void |
| 243 | checkPitExpire(); |
Yingdi Yu | f9fa52f | 2014-02-06 12:27:32 -0800 | [diff] [blame] | 244 | |
Jeff Thompson | b982b6d | 2013-07-15 18:15:45 -0700 | [diff] [blame] | 245 | private: |
Alexander Afanasyev | f39c537 | 2014-02-17 19:42:56 -0800 | [diff] [blame] | 246 | shared_ptr<boost::asio::io_service> m_ioService; |
| 247 | shared_ptr<boost::asio::io_service::work> m_ioServiceWork; // needed if thread needs to be preserved |
| 248 | shared_ptr<boost::asio::deadline_timer> m_pitTimeoutCheckTimer; |
| 249 | bool m_pitTimeoutCheckTimerActive; |
| 250 | shared_ptr<boost::asio::deadline_timer> m_processEventsTimeoutTimer; |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 251 | |
Alexander Afanasyev | f39c537 | 2014-02-17 19:42:56 -0800 | [diff] [blame] | 252 | shared_ptr<Transport> m_transport; |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 253 | |
Alexander Afanasyev | f39c537 | 2014-02-17 19:42:56 -0800 | [diff] [blame] | 254 | PendingInterestTable m_pendingInterestTable; |
| 255 | RegisteredPrefixTable m_registeredPrefixTable; |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 256 | |
| 257 | shared_ptr<Controller> m_fwController; |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 258 | }; |
| 259 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 260 | } // namespace ndn |
Jeff Thompson | aa4e6db | 2013-07-15 17:25:23 -0700 | [diff] [blame] | 261 | |
Alexander Afanasyev | 0222fba | 2014-02-09 23:16:02 -0800 | [diff] [blame] | 262 | #endif // NDN_FACE_HPP |