[GNUnet-SVN] r33064 - gnunet/src/dht

[gnunet]

Author: grothoff
Date: 2014-04-14 15:03:32 +0200 (Mon, 14 Apr 2014)
New Revision: 33064

Modified:
   gnunet/src/dht/gnunet-service-xdht_neighbours.h
Log:
-comments for surpiti

Modified: gnunet/src/dht/gnunet-service-xdht_neighbours.h
===================================================================
--- gnunet/src/dht/gnunet-service-xdht_neighbours.h     2014-04-14 13:02:13 UTC 
(rev 33063)
+++ gnunet/src/dht/gnunet-service-xdht_neighbours.h     2014-04-14 13:03:32 UTC 
(rev 33064)
@@ -36,11 +36,31 @@
  * Field in trail setup message to understand if the message is sent to an
  * intermediate finger, friend or me. 
  */
-enum current_destination_type
+enum current_destination_type /* FIXME: enum GSX_CurrentDestinationType */
 {
-  FRIEND ,
-  FINGER ,
-  MY_ID ,
+  /**
+   * Look in friend AND finger tables for a trail to the key.
+   */
+  /* FIXME: GSX_CDT_ */ FRIEND,
+  
+  /**
+   * Look in the routing table to follow a trail to reach to the
+   * destination.  It is also allowed (but currently not implemented)
+   * to look into friend/finger tables for a better trail to the key
+   * and (if one is found) 'abort' the current trail and switch to
+   * the better one.
+   */
+  FINGER,
+
+  /**
+   * "Returned" if the origin is the closest peer to the destination;
+   * Must not be passed to "GDS_NEIGHBOURS_handle_put".
+   */
+  MY_ID,
+
+  /**
+   * FIXME.
+   */
   VALUE
 };
 
@@ -179,4 +199,4 @@
 GDS_NEIGHBOURS_get_id ();
 
 
-#endif
\ No newline at end of file
+#endif