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 f186f5f8ce146135aa07ac2506ef2434b4de71a1..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.
 */
 
 /**
@@ -49,8 +49,21 @@ enum GDS_ROUTING_trail_direction
  *         #GNUNET_SYSERR in case no matching entry found in routing table. 
  */
 int
-GDS_ROUTING_update_trail_prev_hop (struct GNUNET_HashCode trail_id,
-                                   struct GNUNET_PeerIdentity prev_hop);
+GDS_ROUTING_update_trail_prev_hop (const struct GNUNET_HashCode *trail_id,
+                                   const struct GNUNET_PeerIdentity *prev_hop);
+
+
+/**
+ * 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.
+ */
+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
@@ -58,25 +71,28 @@ GDS_ROUTING_update_trail_prev_hop (struct GNUNET_HashCode trail_id,
  * @return Next_hop if found
  *         NULL If next hop not found. 
  */
-struct GNUNET_PeerIdentity *
-GDS_ROUTING_get_next_hop (struct GNUNET_HashCode trail_id,
+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 
+ * Remove every trail where peer is either next_hop or prev_hop 
  * @param peer Peer to be searched.
  */
-void
+int
 GDS_ROUTING_remove_trail_by_peer (const struct GNUNET_PeerIdentity *peer);
+
+
 /**
  * Remove trail with trail_id
+ *
  * @param trail_id Trail id to be removed
  * @return #GNUNET_YES success 
  *         #GNUNET_NO if entry not found.
  */
 int
-GDS_ROUTING_remove_trail (struct GNUNET_HashCode remove_trail_id);
+GDS_ROUTING_remove_trail (const struct GNUNET_HashCode *remove_trail_id);
 
 
 /**
@@ -89,10 +105,11 @@ GDS_ROUTING_remove_trail (struct GNUNET_HashCode remove_trail_id);
  *                         but with different prev_hop/next_hop
  */
 int
-GDS_ROUTING_add (struct GNUNET_HashCode new_trail_id, 
-                 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 the size of routing table has crossed threshold. 
  * @return #GNUNET_YES, if threshold crossed 
@@ -101,6 +118,13 @@ GDS_ROUTING_add (struct GNUNET_HashCode new_trail_id,
 int
 GDS_ROUTING_threshold_reached (void);
 
+#if 0
+/**
+ * Test function. Remove afterwards. 
+ */
+void 
+GDS_ROUTING_test_print (void);
+#endif
 
 /**
  * Initialize routing subsystem.
@@ -113,4 +137,5 @@ GDS_ROUTING_init (void);
  */
 void
 GDS_ROUTING_done (void);
-#endif
\ No newline at end of file
+
+#endif