blob: 1e4c001a758880e15fe5c74b35a7d4718b64e900 [file] [log] [blame]
Jeff Thompson25b4e612013-10-10 16:03:24 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -07002/**
Jeff Thompson7687dc02013-09-13 11:54:07 -07003 * Copyright (C) 2013 Regents of the University of California.
4 * @author: Jeff Thompson <jefft0@remap.ucla.edu>
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -07005 * See COPYING for copyright and distribution information.
6 */
7
8#ifndef NDN_NODE_HPP
9#define NDN_NODE_HPP
10
Jeff Thompson7aec0252013-08-22 17:29:57 -070011#include "common.hpp"
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070012#include "interest.hpp"
Jeff Thompson86507bc2013-08-23 20:51:38 -070013#include "data.hpp"
14#include "transport/tcp-transport.hpp"
Jeff Thompson1f8a31a2013-09-30 16:18:47 -070015#include "forwarding-flags.hpp"
Jeff Thompson25b4e612013-10-10 16:03:24 -070016#include "encoding/element-listener.hpp"
17
18struct ndn_Interest;
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070019
20namespace ndn {
21
Jeff Thompson7aec0252013-08-22 17:29:57 -070022/**
23 * An OnData function object is used to pass a callback to expressInterest.
24 */
Jeff Thompsona6d15c82013-09-17 15:34:32 -070025typedef func_lib::function<void(const ptr_lib::shared_ptr<const Interest>&, const ptr_lib::shared_ptr<Data>&)> OnData;
Jeff Thompson7aec0252013-08-22 17:29:57 -070026
27/**
28 * An OnTimeout function object is used to pass a callback to expressInterest.
29 */
Jeff Thompsona6d15c82013-09-17 15:34:32 -070030typedef func_lib::function<void(const ptr_lib::shared_ptr<const Interest>&)> OnTimeout;
Jeff Thompson7aec0252013-08-22 17:29:57 -070031
Jeff Thompson86507bc2013-08-23 20:51:38 -070032/**
33 * An OnInterest function object is used to pass a callback to registerPrefix.
34 */
Jeff Thompson9cc4be42013-08-27 18:12:41 -070035typedef func_lib::function<void
Jeff Thompsonb510e3e2013-10-07 18:53:20 -070036 (const ptr_lib::shared_ptr<const Name>&, const ptr_lib::shared_ptr<const Interest>&, Transport&, uint64_t)> OnInterest;
Jeff Thompson86507bc2013-08-23 20:51:38 -070037
Jeff Thompson590ec232013-09-18 15:55:56 -070038/**
39 * An OnRegisterFailed function object is used to report when registerPrefix fails.
40 */
41typedef func_lib::function<void(const ptr_lib::shared_ptr<const Name>&)> OnRegisterFailed;
42
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070043class Face;
Jeff Thompson590ec232013-09-18 15:55:56 -070044class KeyChain;
45
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070046class Node : public ElementListener {
47public:
48 /**
Jeff Thompson10e34382013-08-22 13:34:46 -070049 * Create a new Node for communication with an NDN hub with the given Transport object and connectionInfo.
50 * @param transport A shared_ptr to a Transport object used for communication.
51 * @param transport A shared_ptr to a Transport::ConnectionInfo to be used to connect to the transport.
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070052 */
Jeff Thompson1656e6a2013-08-29 18:01:48 -070053 Node(const ptr_lib::shared_ptr<Transport>& transport, const ptr_lib::shared_ptr<const Transport::ConnectionInfo>& connectionInfo);
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -070054
55 /**
Jeff Thompson4fe45512013-08-23 14:06:38 -070056 * Send the Interest through the transport, read the entire response and call onData(interest, data).
57 * @param interest A reference to the Interest. This copies the Interest.
58 * @param onData A function object to call when a matching data packet is received. This copies the function object, so you may need to
59 * use func_lib::ref() as appropriate.
60 * @param onTimeout A function object to call if the interest times out. If onTimeout is an empty OnTimeout(), this does not use it.
61 * This copies the function object, so you may need to use func_lib::ref() as appropriate.
Jeff Thompson11095142013-10-01 16:20:28 -070062 * @return The pending interest ID which can be used with removePendingInterest.
Jeff Thompson4fe45512013-08-23 14:06:38 -070063 */
Jeff Thompson62992e42013-10-07 18:50:51 -070064 uint64_t
Jeff Thompson0050abe2013-09-17 12:50:25 -070065 expressInterest(const Interest& interest, const OnData& onData, const OnTimeout& onTimeout);
Jeff Thompson7aec0252013-08-22 17:29:57 -070066
67 /**
Jeff Thompson11095142013-10-01 16:20:28 -070068 * Remove the pending interest entry with the pendingInterestId from the pending interest table.
69 * This does not affect another pending interest with a different pendingInterestId, even it if has the same interest name.
70 * If there is no entry with the pendingInterestId, do nothing.
71 * @param pendingInterestId The ID returned from expressInterest.
72 */
73 void
Jeff Thompson62992e42013-10-07 18:50:51 -070074 removePendingInterest(uint64_t pendingInterestId);
Jeff Thompson11095142013-10-01 16:20:28 -070075
76 /**
Jeff Thompson86507bc2013-08-23 20:51:38 -070077 * Register prefix with the connected NDN hub and call onInterest when a matching interest is received.
78 * @param prefix A reference to a Name for the prefix to register. This copies the Name.
79 * @param onInterest A function object to call when a matching interest is received. This copies the function object, so you may need to
80 * use func_lib::ref() as appropriate.
Jeff Thompson590ec232013-09-18 15:55:56 -070081 * @param onRegisterFailed A function object to call if failed to retrieve the connected hub’s ID or failed to register the prefix.
82 * This calls onRegisterFailed(prefix) where prefix is the prefix given to registerPrefix.
Jeff Thompson86507bc2013-08-23 20:51:38 -070083 * @param flags The flags for finer control of which interests are forward to the application.
Jeff Thompson590ec232013-09-18 15:55:56 -070084 * @param wireFormat A WireFormat object used to encode the input. If omitted, use WireFormat getDefaultWireFormat().
Jeff Thompson11095142013-10-01 16:20:28 -070085 * @return The registered prefix ID which can be used with removeRegisteredPrefix.
Jeff Thompson86507bc2013-08-23 20:51:38 -070086 */
Jeff Thompson62992e42013-10-07 18:50:51 -070087 uint64_t
Jeff Thompson590ec232013-09-18 15:55:56 -070088 registerPrefix
Jeff Thompson1f8a31a2013-09-30 16:18:47 -070089 (const Name& prefix, const OnInterest& onInterest, const OnRegisterFailed& onRegisterFailed, const ForwardingFlags& flags,
90 WireFormat& wireFormat);
Jeff Thompson86507bc2013-08-23 20:51:38 -070091
92 /**
Jeff Thompson11095142013-10-01 16:20:28 -070093 * Remove the registered prefix entry with the registeredPrefixId from the pending interest table.
94 * This does not affect another registered prefix with a different registeredPrefixId, even it if has the same prefix name.
95 * If there is no entry with the registeredPrefixId, do nothing.
96 * @param registeredPrefixId The ID returned from registerPrefix.
97 */
98 void
Jeff Thompson62992e42013-10-07 18:50:51 -070099 removeRegisteredPrefix(uint64_t registeredPrefixId);
Jeff Thompson11095142013-10-01 16:20:28 -0700100
101 /**
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700102 * Process any data to receive. For each element received, call onReceivedElement.
103 * This is non-blocking and will return immediately if there is no data to receive.
104 * You should repeatedly call this from an event loop, with calls to sleep as needed so that the loop doesn't use 100% of the CPU.
105 * @throw This may throw an exception for reading data or in the callback for processing the data. If you
106 * call this from an main event loop, you may want to catch and log/disregard all exceptions.
107 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700108 void
109 processEvents();
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700110
Jeff Thompson0050abe2013-09-17 12:50:25 -0700111 const ptr_lib::shared_ptr<Transport>&
112 getTransport() { return transport_; }
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700113
Jeff Thompson0050abe2013-09-17 12:50:25 -0700114 const ptr_lib::shared_ptr<const Transport::ConnectionInfo>&
115 getConnectionInfo() { return connectionInfo_; }
Jeff Thompson10e34382013-08-22 13:34:46 -0700116
Jeff Thompson0050abe2013-09-17 12:50:25 -0700117 void
Jeff Thompson97223af2013-09-24 17:01:27 -0700118 onReceivedElement(const uint8_t *element, size_t elementLength);
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700119
Jeff Thompson0050abe2013-09-17 12:50:25 -0700120 void
121 shutdown();
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700122
123private:
Jeff Thompson11095142013-10-01 16:20:28 -0700124 class PendingInterest {
Jeff Thompson557b81e2013-08-21 15:13:51 -0700125 public:
126 /**
127 * Create a new PitEntry and set the timeoutTime_ based on the current time and the interest lifetime.
Jeff Thompson11095142013-10-01 16:20:28 -0700128 * @param pendingInterestId A unique ID for this entry, which you should get with getNextPendingInteresId().
Jeff Thompson48917f02013-08-21 17:12:45 -0700129 * @param interest A shared_ptr for the interest.
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700130 * @param onData A function object to call when a matching data packet is received.
Jeff Thompson7aec0252013-08-22 17:29:57 -0700131 * @param onTimeout A function object to call if the interest times out. If onTimeout is an empty OnTimeout(), this does not use it.
Jeff Thompson557b81e2013-08-21 15:13:51 -0700132 */
Jeff Thompson11095142013-10-01 16:20:28 -0700133 PendingInterest
Jeff Thompson62992e42013-10-07 18:50:51 -0700134 (uint64_t pendingInterestId, const ptr_lib::shared_ptr<const Interest>& interest, const OnData& onData,
Jeff Thompson11095142013-10-01 16:20:28 -0700135 const OnTimeout& onTimeout);
136
137 /**
138 * Return the next unique pending interest ID.
139 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700140 static uint64_t
Jeff Thompson11095142013-10-01 16:20:28 -0700141 getNextPendingInterestId()
142 {
143 return ++lastPendingInterestId_;
144 }
145
146 /**
147 * Return the pendingInterestId given to the constructor.
148 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700149 uint64_t
Jeff Thompson11095142013-10-01 16:20:28 -0700150 getPendingInterestId() { return pendingInterestId_; }
Jeff Thompson557b81e2013-08-21 15:13:51 -0700151
Jeff Thompson0050abe2013-09-17 12:50:25 -0700152 const ptr_lib::shared_ptr<const Interest>&
153 getInterest() { return interest_; }
Jeff Thompson557b81e2013-08-21 15:13:51 -0700154
Jeff Thompson0050abe2013-09-17 12:50:25 -0700155 const OnData&
156 getOnData() { return onData_; }
Jeff Thompson557b81e2013-08-21 15:13:51 -0700157
158 /**
Jeff Thompson48917f02013-08-21 17:12:45 -0700159 * Get the struct ndn_Interest for the interest_.
Jeff Thompson557b81e2013-08-21 15:13:51 -0700160 * WARNING: Assume that this PitEntry was created with new, so that no copy constructor is invoked between calls.
161 * This class is private to Node and only used by its methods, so this should be OK.
162 * TODO: Doesn't this functionality belong in the Interest class?
163 * @return A reference to the ndn_Interest struct.
164 * WARNING: The resulting pointers in are invalid uses getInterest() to manipulate the object which could reallocate memory.
165 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700166 const struct ndn_Interest&
167 getInterestStruct()
Jeff Thompson48917f02013-08-21 17:12:45 -0700168 {
Jeff Thompson25b4e612013-10-10 16:03:24 -0700169 return *interestStruct_;
Jeff Thompson48917f02013-08-21 17:12:45 -0700170 }
171
172 /**
Jeff Thompson7aec0252013-08-22 17:29:57 -0700173 * If this interest is timed out, call onTimeout_ (if defined) and return true.
Jeff Thompson48917f02013-08-21 17:12:45 -0700174 * @param parent The parent Node for the UpcallInfo.
Jeff Thompson9a8e82f2013-10-17 14:13:43 -0700175 * @param nowMilliseconds The current time in milliseconds from ndn_getNowMilliseconds.
Jeff Thompson48917f02013-08-21 17:12:45 -0700176 * @return true if this interest timed out and the timeout callback was called, otherwise false.
177 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700178 bool
Jeff Thompson9a8e82f2013-10-17 14:13:43 -0700179 checkTimeout(Node *parent, MillisecondsSince1970 nowMilliseconds);
Jeff Thompson557b81e2013-08-21 15:13:51 -0700180
181 private:
Jeff Thompson48917f02013-08-21 17:12:45 -0700182 ptr_lib::shared_ptr<const Interest> interest_;
Jeff Thompson557b81e2013-08-21 15:13:51 -0700183 std::vector<struct ndn_NameComponent> nameComponents_;
184 std::vector<struct ndn_ExcludeEntry> excludeEntries_;
Jeff Thompson25b4e612013-10-10 16:03:24 -0700185 ptr_lib::shared_ptr<struct ndn_Interest> interestStruct_;
Jeff Thompson557b81e2013-08-21 15:13:51 -0700186
Jeff Thompson62992e42013-10-07 18:50:51 -0700187 static uint64_t lastPendingInterestId_; /**< A class variable used to get the next unique ID. */
188 uint64_t pendingInterestId_; /**< A unique identifier for this entry so it can be deleted */
Jeff Thompson7aec0252013-08-22 17:29:57 -0700189 const OnData onData_;
190 const OnTimeout onTimeout_;
Jeff Thompson9a8e82f2013-10-17 14:13:43 -0700191 MillisecondsSince1970 timeoutTimeMilliseconds_; /**< The time when the interest times out in milliseconds according to ndn_getNowMilliseconds, or -1 for no timeout. */
Jeff Thompson557b81e2013-08-21 15:13:51 -0700192 };
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700193
Jeff Thompson11095142013-10-01 16:20:28 -0700194 class RegisteredPrefix {
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700195 public:
196 /**
197 * Create a new PrefixEntry.
Jeff Thompson11095142013-10-01 16:20:28 -0700198 * @param registeredPrefixId A unique ID for this entry, which you should get with getNextRegisteredPrefixId().
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700199 * @param prefix A shared_ptr for the prefix.
200 * @param onInterest A function object to call when a matching data packet is received.
201 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700202 RegisteredPrefix(uint64_t registeredPrefixId, const ptr_lib::shared_ptr<const Name>& prefix, const OnInterest& onInterest)
Jeff Thompson11095142013-10-01 16:20:28 -0700203 : registeredPrefixId_(registeredPrefixId), prefix_(prefix), onInterest_(onInterest)
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700204 {
205 }
206
Jeff Thompson11095142013-10-01 16:20:28 -0700207 /**
208 * Return the next unique entry ID.
209 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700210 static uint64_t
Jeff Thompson11095142013-10-01 16:20:28 -0700211 getNextRegisteredPrefixId()
212 {
213 return ++lastRegisteredPrefixId_;
214 }
215
216 /**
217 * Return the registeredPrefixId given to the constructor.
218 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700219 uint64_t
Jeff Thompson11095142013-10-01 16:20:28 -0700220 getRegisteredPrefixId() { return registeredPrefixId_; }
221
Jeff Thompson0050abe2013-09-17 12:50:25 -0700222 const ptr_lib::shared_ptr<const Name>&
223 getPrefix() { return prefix_; }
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700224
Jeff Thompson0050abe2013-09-17 12:50:25 -0700225 const OnInterest&
226 getOnInterest() { return onInterest_; }
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700227
228 private:
Jeff Thompson62992e42013-10-07 18:50:51 -0700229 static uint64_t lastRegisteredPrefixId_; /**< A class variable used to get the next unique ID. */
230 uint64_t registeredPrefixId_; /**< A unique identifier for this entry so it can be deleted */
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700231 ptr_lib::shared_ptr<const Name> prefix_;
232 const OnInterest onInterest_;
233 };
Jeff Thompson557b81e2013-08-21 15:13:51 -0700234
235 /**
Jeff Thompson86507bc2013-08-23 20:51:38 -0700236 * An NdndIdFetcher receives the Data packet with the publisher public key digest for the connected NDN hub.
237 * This class is a function object for the callbacks. It only holds a pointer to an Info object, so it is OK to copy the pointer.
238 */
239 class NdndIdFetcher {
240 public:
241 class Info;
242 NdndIdFetcher(ptr_lib::shared_ptr<NdndIdFetcher::Info> info)
243 : info_(info)
244 {
245 }
246
247 /**
248 * We received the ndnd ID.
249 * @param interest
250 * @param data
251 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700252 void
253 operator()(const ptr_lib::shared_ptr<const Interest>& interest, const ptr_lib::shared_ptr<Data>& ndndIdData);
Jeff Thompson86507bc2013-08-23 20:51:38 -0700254
255 /**
256 * We timed out fetching the ndnd ID.
257 * @param interest
258 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700259 void
260 operator()(const ptr_lib::shared_ptr<const Interest>& timedOutInterest);
Jeff Thompson86507bc2013-08-23 20:51:38 -0700261
262 class Info {
263 public:
Jeff Thompson11095142013-10-01 16:20:28 -0700264 /**
265 *
266 * @param node
267 * @param registeredPrefixId The PrefixEntry::getNextRegisteredPrefixId() which registerPrefix got so it could return it to the caller.
268 * @param prefix
269 * @param onInterest
270 * @param onRegisterFailed
271 * @param flags
272 * @param wireFormat
273 */
Jeff Thompson62992e42013-10-07 18:50:51 -0700274 Info(Node *node, uint64_t registeredPrefixId, const Name& prefix, const OnInterest& onInterest,
Jeff Thompson11095142013-10-01 16:20:28 -0700275 const OnRegisterFailed& onRegisterFailed, const ForwardingFlags& flags, WireFormat& wireFormat)
276 : node_(*node), registeredPrefixId_(registeredPrefixId), prefix_(new Name(prefix)), onInterest_(onInterest), onRegisterFailed_(onRegisterFailed),
Jeff Thompson6d7369b2013-09-19 14:40:21 -0700277 flags_(flags), wireFormat_(wireFormat)
Jeff Thompson86507bc2013-08-23 20:51:38 -0700278 {
279 }
280
Jeff Thompson1656e6a2013-08-29 18:01:48 -0700281 Node& node_;
Jeff Thompson62992e42013-10-07 18:50:51 -0700282 uint64_t registeredPrefixId_;
Jeff Thompson590ec232013-09-18 15:55:56 -0700283 ptr_lib::shared_ptr<const Name> prefix_;
Jeff Thompson86507bc2013-08-23 20:51:38 -0700284 const OnInterest onInterest_;
Jeff Thompson590ec232013-09-18 15:55:56 -0700285 const OnRegisterFailed onRegisterFailed_;
Jeff Thompson1f8a31a2013-09-30 16:18:47 -0700286 ForwardingFlags flags_;
Jeff Thompson590ec232013-09-18 15:55:56 -0700287 WireFormat& wireFormat_;
Jeff Thompson86507bc2013-08-23 20:51:38 -0700288 };
289
290 private:
291 ptr_lib::shared_ptr<Info> info_;
292 };
293
294 /**
Jeff Thompson557b81e2013-08-21 15:13:51 -0700295 * Find the entry from the pit_ where the name conforms to the entry's interest selectors, and
296 * the entry interest name is the longest that matches name.
297 * @param name The name to find the interest for (from the incoming data packet).
298 * @return The index in pit_ of the pit entry, or -1 if not found.
299 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700300 int
Jeff Thompson590ec232013-09-18 15:55:56 -0700301 getEntryIndexForExpressedInterest(const Name& name);
Jeff Thompson557b81e2013-08-21 15:13:51 -0700302
Jeff Thompson86507bc2013-08-23 20:51:38 -0700303 /**
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700304 * Find the first entry from the registeredPrefixTable_ where the entry prefix is the longest that matches name.
305 * @param name The name to find the PrefixEntry for (from the incoming interest packet).
306 * @return A pointer to the entry, or 0 if not found.
307 */
Jeff Thompson11095142013-10-01 16:20:28 -0700308 RegisteredPrefix*
Jeff Thompson0050abe2013-09-17 12:50:25 -0700309 getEntryForRegisteredPrefix(const Name& name);
Jeff Thompson590ec232013-09-18 15:55:56 -0700310
Jeff Thompson9cc4be42013-08-27 18:12:41 -0700311 /**
Jeff Thompson86507bc2013-08-23 20:51:38 -0700312 * Do the work of registerPrefix once we know we are connected with an ndndId_.
Jeff Thompson11095142013-10-01 16:20:28 -0700313 * @param registeredPrefixId The PrefixEntry::getNextRegisteredPrefixId() which registerPrefix got so it could return it to the caller.
Jeff Thompson86507bc2013-08-23 20:51:38 -0700314 * @param prefix
315 * @param onInterest
Jeff Thompson590ec232013-09-18 15:55:56 -0700316 * @param onRegisterFailed
Jeff Thompson86507bc2013-08-23 20:51:38 -0700317 * @param flags
Jeff Thompson590ec232013-09-18 15:55:56 -0700318 * @param wireFormat
319 */
Jeff Thompson0050abe2013-09-17 12:50:25 -0700320 void
Jeff Thompson590ec232013-09-18 15:55:56 -0700321 registerPrefixHelper
Jeff Thompson62992e42013-10-07 18:50:51 -0700322 (uint64_t registeredPrefixId, const ptr_lib::shared_ptr<const Name>& prefix, const OnInterest& onInterest,
Jeff Thompson11095142013-10-01 16:20:28 -0700323 const OnRegisterFailed& onRegisterFailed, const ForwardingFlags& flags, WireFormat& wireFormat);
Jeff Thompson86507bc2013-08-23 20:51:38 -0700324
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700325 ptr_lib::shared_ptr<Transport> transport_;
Jeff Thompson10e34382013-08-22 13:34:46 -0700326 ptr_lib::shared_ptr<const Transport::ConnectionInfo> connectionInfo_;
Jeff Thompson11095142013-10-01 16:20:28 -0700327 std::vector<ptr_lib::shared_ptr<PendingInterest> > pendingInterestTable_;
328 std::vector<ptr_lib::shared_ptr<RegisteredPrefix> > registeredPrefixTable_;
Jeff Thompson86507bc2013-08-23 20:51:38 -0700329 Interest ndndIdFetcherInterest_;
Jeff Thompson03616c92013-09-12 14:30:01 -0700330 Blob ndndId_;
Jeff Thompsonbf50a1a2013-08-20 18:01:01 -0700331};
332
333}
334
335#endif