-add missing comments, expand error checking

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

diff --git a/src/dht/gnunet-service-dht_neighbours.h b/src/dht/gnunet-service-dht_neighbours.h
index 70723deac062acec04ca5826f8869abc2dcc8a24..b6e0f0ec0fbf6b342f276a555e8d2be28629c3f9 100644 (file)
--- a/src/dht/gnunet-service-dht_neighbours.h
+++ b/src/dht/gnunet-service-dht_neighbours.h
@@ -27,6 +27,9 @@
 #ifndef GNUNET_SERVICE_DHT_NEIGHBOURS_H
 #define GNUNET_SERVICE_DHT_NEIGHBOURS_H
 
+#include "gnunet_util_lib.h"
+#include "gnunet_block_lib.h"
+#include "gnunet_dht_service.h"
 
 /**
  * Perform a PUT operation.  Forwards the given request to other
@@ -49,16 +52,15 @@
  */
 void
 GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
-                          enum GNUNET_DHT_RouteOption options,
-                          uint32_t desired_replication_level,
-                          GNUNET_TIME_Absolute expiration_time,
-                          uint32_t hop_count,
-                          struct GNUNET_CONTAINER_BloomFilter *bf,
-                          const GNUNET_HashCode *key,
-                          unsigned int put_path_length,
-                          struct GNUNET_PeerIdentity *put_path,
-                          const void *data,
-                          size_t data_size);
+                           enum GNUNET_DHT_RouteOption options,
+                           uint32_t desired_replication_level,
+                           struct GNUNET_TIME_Absolute expiration_time,
+                           uint32_t hop_count,
+                           struct GNUNET_CONTAINER_BloomFilter *bf,
+                           const GNUNET_HashCode * key,
+                           unsigned int put_path_length,
+                           struct GNUNET_PeerIdentity *put_path,
+                           const void *data, size_t data_size);
 
 
 /**
@@ -76,19 +78,17 @@ GDS_NEIGHBOURS_handle_put (enum GNUNET_BLOCK_Type type,
  * @param xquery_size number of bytes in xquery
  * @param reply_bf bloomfilter to filter duplicates
  * @param reply_bf_mutator mutator for reply_bf
- * @param peer_bf filter for peers not to select (again)
+ * @param peer_bf filter for peers not to select (again, updated)
  */
 void
 GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
-                          enum GNUNET_DHT_RouteOption options,
-                          uint32_t desired_replication_level,
-                          uint32_t hop_count,
-                          const GNUNET_HashCode *key,
-                          const void *xquery,
-                          size_t xquery_size,
-                          const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
-                          uint32_t reply_bf_mutator,
-                          const struct GNUNET_CONTAINER_BloomFilter *peer_bf);
+                           enum GNUNET_DHT_RouteOption options,
+                           uint32_t desired_replication_level,
+                           uint32_t hop_count, const GNUNET_HashCode * key,
+                           const void *xquery, size_t xquery_size,
+                           const struct GNUNET_CONTAINER_BloomFilter *reply_bf,
+                           uint32_t reply_bf_mutator,
+                           struct GNUNET_CONTAINER_BloomFilter *peer_bf);
 
 
 /**
@@ -108,24 +108,26 @@ GDS_NEIGHBOURS_handle_get (enum GNUNET_BLOCK_Type type,
  * @param data_size number of bytes in data
  */
 void
-GDS_NEIGHBOURS_handle_reply (const GNUNET_PeerIdentity *target,
-                            enum GNUNET_BLOCK_Type type,
-                            GNUNET_TIME_Absolute expiration_time,
-                            const GNUNET_HashCode *key,
-                            unsigned int put_path_length,
-                            struct GNUNET_PeerIdentity *put_path,
-                            unsigned int get_path_length,
-                            struct GNUNET_PeerIdentity *get_path,
-                            const void *data,
-                            size_t data_size);
+GDS_NEIGHBOURS_handle_reply (const struct GNUNET_PeerIdentity *target,
+                             enum GNUNET_BLOCK_Type type,
+                             struct GNUNET_TIME_Absolute expiration_time,
+                             const GNUNET_HashCode * key,
+                             unsigned int put_path_length,
+                             const struct GNUNET_PeerIdentity *put_path,
+                             unsigned int get_path_length,
+                             const struct GNUNET_PeerIdentity *get_path,
+                             const void *data, size_t data_size);
 
 
 /**
  * Initialize neighbours subsystem.
+ *
+ * @return GNUNET_OK on success, GNUNET_SYSERR on error
  */
-void
+int
 GDS_NEIGHBOURS_init (void);
 
+
 /**
  * Shutdown neighbours subsystem.
  */