More API function tests...

[oweals/gnunet.git] / src / dht / gnunet-service-xdht_routing.h

diff --git a/src/dht/gnunet-service-xdht_routing.h b/src/dht/gnunet-service-xdht_routing.h
index 63007c7e479bc135123fe6e4882c94108ab34e93..69ab1ff78bc10bbd1783cad1d5eba0555875f377 100644 (file)
--- a/src/dht/gnunet-service-xdht_routing.h
+++ b/src/dht/gnunet-service-xdht_routing.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011 - 2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011 - 2014 GNUnet e.V.
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
@@ -30,60 +30,101 @@
 #include "gnunet_block_lib.h"
 #include "gnunet_dht_service.h"
 
+/**
+ * To understand the direction in which trial should be read. 
+ */
+enum GDS_ROUTING_trail_direction 
+{
+  GDS_ROUTING_SRC_TO_DEST,
+  GDS_ROUTING_DEST_TO_SRC
+};
+
 
 /**
- * Add a new entry to our routing table.
- * @param source peer Source of the trail.
- * @param destintation Destination of the trail.
- * @param next_hop Next peer to forward the message to reach the destination.
- * @return GNUNET_YES
- *         GNUNET_SYSERR If the number of routing entries crossed thershold.
+ * Update the prev. hop of the trail. Call made by trail teardown where
+ * if you are the first friend now in the trail then you need to update
+ * your prev. hop.
+ * @param trail_id
+ * @return #GNUNET_OK success
+ *         #GNUNET_SYSERR in case no matching entry found in routing table. 
  */
 int
-GDS_ROUTING_add (const struct GNUNET_PeerIdentity *source,
-                 const struct GNUNET_PeerIdentity *dest,
-                 const struct GNUNET_PeerIdentity *next_hop,
-                 struct GNUNET_PeerIdentity *prev_hop);
+GDS_ROUTING_update_trail_prev_hop (const struct GNUNET_HashCode *trail_id,
+                                   const struct GNUNET_PeerIdentity *prev_hop);
 
 
 /**
- * Iterate over routing table and remove entries for which peer is a part. 
- * @param peer
- * @return 
+ * Update the next hop of the trail. Call made by trail compression where
+ * if you are source of the trail and now you have a new first friend, then
+ * you should update the trail. 
+ * @param trail_id
+ * @return #GNUNET_OK success
+ *         #GNUNET_SYSERR in case no matching entry found in routing table.
  */
-void
-GDS_ROUTING_remove_entry (const struct GNUNET_PeerIdentity *peer);
+int
+GDS_ROUTING_update_trail_next_hop (const struct GNUNET_HashCode *trail_id,
+                                   const struct GNUNET_PeerIdentity *next_hop);
+
+/**
+ * Get the next hop for trail corresponding to trail_id
+ * @param trail_id Trail id to be searched. 
+ * @return Next_hop if found
+ *         NULL If next hop not found. 
+ */
+const struct GNUNET_PeerIdentity *
+GDS_ROUTING_get_next_hop (const struct GNUNET_HashCode *trail_id,
+                          enum GDS_ROUTING_trail_direction trail_direction);
+
+
+/**
+ * Remove every trail where peer is either next_hop or prev_hop 
+ * @param peer Peer to be searched.
+ */
+int
+GDS_ROUTING_remove_trail_by_peer (const struct GNUNET_PeerIdentity *peer);
 
 
 /**
- * Search the next hop to send the packet to in routing table.
- * @return next hop peer id
+ * Remove trail with trail_id
+ *
+ * @param trail_id Trail id to be removed
+ * @return #GNUNET_YES success 
+ *         #GNUNET_NO if entry not found.
  */
-struct GNUNET_PeerIdentity *
-GDS_ROUTING_search(struct GNUNET_PeerIdentity *source_peer,
-                   struct GNUNET_PeerIdentity *destination_peer,
-                   const struct GNUNET_PeerIdentity *prev_hop);
+int
+GDS_ROUTING_remove_trail (const struct GNUNET_HashCode *remove_trail_id);
+
 
 /**
- * Remove the trail as result of trail tear down message. 
- * @param source_peer Source of the trail.
- * @param destination_peer Destination of the trail.
- * @param next_hop Next hop
- * @param prev_hop Previous hop. 
- * @return #GNUNET_YES if successful
- *         #GNUNET_NO if not successful. 
+ * Add a new entry in routing table
+ * @param new_trail_id
+ * @param prev_hop
+ * @param next_hop
+ * @return #GNUNET_OK success
+ *         #GNUNET_SYSERR in case new_trail_id already exists in the network
+ *                         but with different prev_hop/next_hop
  */
 int
-GDS_ROUTING_remove_trail (struct GNUNET_PeerIdentity *source_peer,
-                          struct GNUNET_PeerIdentity *destination_peer, 
-                          const struct GNUNET_PeerIdentity *prev_hop);
+GDS_ROUTING_add (const struct GNUNET_HashCode *new_trail_id, 
+                 const struct GNUNET_PeerIdentity *prev_hop,
+                 const struct GNUNET_PeerIdentity *next_hop);
 
 
 /**
- * Check if size of routing table is greater than threshold or not. 
+ * Check if the size of routing table has crossed threshold. 
+ * @return #GNUNET_YES, if threshold crossed 
+ *         #GNUNET_NO, if size is within threshold 
  */
 int
-GDS_ROUTING_check_threshold (void);
+GDS_ROUTING_threshold_reached (void);
+
+#if 0
+/**
+ * Test function. Remove afterwards. 
+ */
+void 
+GDS_ROUTING_test_print (void);
+#endif
 
 /**
  * Initialize routing subsystem.
@@ -91,7 +132,6 @@ GDS_ROUTING_check_threshold (void);
 void
 GDS_ROUTING_init (void);
 
-
 /**
  * Shutdown routing subsystem.
  */