curly wars / auto-indentation

[oweals/gnunet.git] / src / include / gnunet_dht_service.h

diff --git a/src/include/gnunet_dht_service.h b/src/include/gnunet_dht_service.h
index f4c68bab6b19851b311c48bd11e7486165a20171..f047bd8f8e874e1f2213ac51fef85bd6a5227ea6 100644 (file)
--- a/src/include/gnunet_dht_service.h
+++ b/src/include/gnunet_dht_service.h
@@ -1,10 +1,10 @@
 /*
       This file is part of GNUnet
 /*
       This file is part of GNUnet

-      (C) 2004, 2005, 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
+      (C) 2004, 2005, 2006, 2008, 2009, 2011 Christian Grothoff (and other contributing authors)

 
       GNUnet is free software; you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published
 
       GNUnet is free software; you can redistribute it and/or modify
       it under the terms of the GNU General Public License as published

-      by the Free Software Foundation; either version 2, or (at your
+      by the Free Software Foundation; either version 3, or (at your

       option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
       option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but


@@ -28,6 +28,8 @@
 #define GNUNET_DHT_SERVICE_H
 
 #include "gnunet_util_lib.h"
 #define GNUNET_DHT_SERVICE_H
 
 #include "gnunet_util_lib.h"

+#include "gnunet_block_lib.h"
+#include "gnunet_hello_lib.h"

 
 #ifdef __cplusplus
 extern "C"
 
 #ifdef __cplusplus
 extern "C"


@@ -39,14 +41,16 @@ extern "C"
 
 
 /**
 
 
 /**

- * Connection to the DHT service.
+ * Default republication frequency for stored data in the DHT.

  */
  */

-struct GNUNET_DHT_Handle;
+#define GNUNET_DHT_DEFAULT_REPUBLISH_FREQUENCY GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MINUTES, 60)
+
+

 
 /**
 
 /**

- * Handle to control a route operation.
+ * Connection to the DHT service.

  */
  */

-struct GNUNET_DHT_RouteHandle;
+struct GNUNET_DHT_Handle;

 
 /**
  * Handle to control a get operation.
 
 /**
  * Handle to control a get operation.


@@ -60,24 +64,49 @@ struct GNUNET_DHT_FindPeerHandle;
 
 
 /**
 
 
 /**

- * Iterator called on each result obtained from a generic route
- * operation
+ * Options for routing.

  */
  */

-typedef void (*GNUNET_DHT_MessageCallback)(void *cls,
-                                           int code);
+enum GNUNET_DHT_RouteOption
+{
+    /**
+     * Default.  Do nothing special.
+     */
+  GNUNET_DHT_RO_NONE = 0,
+
+    /**
+     * Each peer along the way should look at 'enc' (otherwise
+     * only the k-peers closest to the key should look at it).
+     */
+  GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1,
+
+    /**
+     * We should keep track of the route that the message
+     * took in the P2P network.
+     */
+  GNUNET_DHT_RO_RECORD_ROUTE = 2,
+
+  /**
+   * This is a 'FIND-PEER' request, so approximate results are fine.
+   */
+  GNUNET_DHT_RO_FIND_PEER = 4,
+
+    /**
+     * Possible message option for query key randomization.
+     */
+  GNUNET_DHT_RO_BART = 8
+};
+

 
 /**
  * Initialize the connection with the DHT service.
  *
 
 /**
  * Initialize the connection with the DHT service.
  *

- * @param sched scheduler to use

  * @param cfg configuration to use
  * @param ht_len size of the internal hash table to use for
  *               processing multiple GET/FIND requests in parallel
  * @return NULL on error
  */
 struct GNUNET_DHT_Handle *
  * @param cfg configuration to use
  * @param ht_len size of the internal hash table to use for
  *               processing multiple GET/FIND requests in parallel
  * @return NULL on error
  */
 struct GNUNET_DHT_Handle *

-GNUNET_DHT_connect (struct GNUNET_SCHEDULER_Handle *sched,
-                    const struct GNUNET_CONFIGURATION_Handle *cfg,
+GNUNET_DHT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,

                     unsigned int ht_len);
 
 
                     unsigned int ht_len);
 
 


@@ -90,33 +119,31 @@ void
 GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle);
 
 
 GNUNET_DHT_disconnect (struct GNUNET_DHT_Handle *handle);
 
 

+/* *************** Standard API: get and put ******************* */
+

 /**
 /**

- * Perform a PUT operation on the DHT identified by 'table' storing
- * a binding of 'key' to 'value'.  The peer does not have to be part
- * of the table (if so, we will attempt to locate a peer that is!)
+ * Perform a PUT operation storing data in the DHT.

  *
  * @param handle handle to DHT service
  * @param key the key to store under
  *
  * @param handle handle to DHT service
  * @param key the key to store under

+ * @param desired_replication_level estimate of how many
+ *                nearest peers this request should reach
+ * @param options routing options for this message

  * @param type type of the value
  * @param size number of bytes in data; must be less than 64k
  * @param data the data to store
  * @param type type of the value
  * @param size number of bytes in data; must be less than 64k
  * @param data the data to store

- * @param exp desired expiration time for the data
- * @param timeout when to abort with an error if we fail to get
- *                a confirmation for the PUT from the local DHT service
- * @param cont continuation to call when done;
- *             reason will be TIMEOUT on error,
- *             reason will be PREREQ_DONE on success
+ * @param exp desired expiration time for the value
+ * @param timeout how long to wait for transmission of this request
+ * @param cont continuation to call when done (transmitting request to service)

  * @param cont_cls closure for cont
  */
 void
  * @param cont_cls closure for cont
  */
 void

-GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle,
-                const GNUNET_HashCode * key,
-                uint32_t type,
-                uint32_t size,
-                const char *data,
+GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle, const GNUNET_HashCode * key,
+                uint32_t desired_replication_level,
+                enum GNUNET_DHT_RouteOption options,
+                enum GNUNET_BLOCK_Type type, size_t size, const char *data,

                 struct GNUNET_TIME_Absolute exp,
                 struct GNUNET_TIME_Absolute exp,

-                struct GNUNET_TIME_Relative timeout,
-                GNUNET_SCHEDULER_Task cont,
+                struct GNUNET_TIME_Relative timeout, GNUNET_SCHEDULER_Task cont,

                 void *cont_cls);
 
 
                 void *cont_cls);
 
 


@@ -127,160 +154,64 @@ GNUNET_DHT_put (struct GNUNET_DHT_Handle *handle,
  * @param cls closure
  * @param exp when will this value expire
  * @param key key of the result
  * @param cls closure
  * @param exp when will this value expire
  * @param key key of the result

+ * @param get_path peers on reply path (or NULL if not recorded)
+ * @param get_path_length number of entries in get_path
+ * @param put_path peers on the PUT path (or NULL if not recorded)
+ * @param put_path_length number of entries in get_path

  * @param type type of the result
  * @param size number of bytes in data
  * @param data pointer to the result data
  */
  * @param type type of the result
  * @param size number of bytes in data
  * @param data pointer to the result data
  */

-typedef void (*GNUNET_DHT_GetIterator)(void *cls,
-                                   struct GNUNET_TIME_Absolute exp,
-                                   const GNUNET_HashCode * key,
-                                   uint32_t type,
-                                   uint32_t size,
-                                   const void *data);
+typedef void (*GNUNET_DHT_GetIterator) (void *cls,
+                                        struct GNUNET_TIME_Absolute exp,
+                                        const GNUNET_HashCode * key,
+                                        const struct GNUNET_PeerIdentity *
+                                        get_path, unsigned int get_path_length,
+                                        const struct GNUNET_PeerIdentity *
+                                        put_path, unsigned int put_path_length,
+                                        enum GNUNET_BLOCK_Type type,
+                                        size_t size, const void *data);

 
 
 
 /**
 
 
 
 /**

- * Perform an asynchronous GET operation on the DHT.
+ * Perform an asynchronous GET operation on the DHT identified. See
+ * also "GNUNET_BLOCK_evaluate".

  *
  * @param handle handle to the DHT service
  *
  * @param handle handle to the DHT service

- * @param timeout timeout for this request to be sent to the
- *        service
+ * @param timeout how long to wait for transmission of this request to the service

  * @param type expected type of the response object
  * @param key the key to look up
  * @param type expected type of the response object
  * @param key the key to look up

+ * @param desired_replication_level estimate of how many
+                  nearest peers this request should reach
+ * @param options routing options for this message
+ * @param xquery extended query data (can be NULL, depending on type)
+ * @param xquery_size number of bytes in xquery

  * @param iter function to call on each result
  * @param iter_cls closure for iter
  * @param iter function to call on each result
  * @param iter_cls closure for iter

- * @param cont continuation to call once message sent
- * @param cont_cls closure for continuation

  *
  *

- * @return handle to stop the async get, NULL on error
+ * @return handle to stop the async get

  */
 struct GNUNET_DHT_GetHandle *
 GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle,
                       struct GNUNET_TIME_Relative timeout,
  */
 struct GNUNET_DHT_GetHandle *
 GNUNET_DHT_get_start (struct GNUNET_DHT_Handle *handle,
                       struct GNUNET_TIME_Relative timeout,

-                      uint32_t type,
-                      const GNUNET_HashCode * key,
-                      GNUNET_DHT_GetIterator iter,
-                      void *iter_cls,
-                      GNUNET_SCHEDULER_Task cont,
-                      void *cont_cls);
+                      enum GNUNET_BLOCK_Type type, const GNUNET_HashCode * key,
+                      uint32_t desired_replication_level,
+                      enum GNUNET_DHT_RouteOption options, const void *xquery,
+                      size_t xquery_size, GNUNET_DHT_GetIterator iter,
+                      void *iter_cls);
+

 
 /**
  * Stop async DHT-get.  Frees associated resources.
  *
  * @param get_handle GET operation to stop.
 
 /**
  * Stop async DHT-get.  Frees associated resources.
  *
  * @param get_handle GET operation to stop.

- */
-void
-GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle, GNUNET_SCHEDULER_Task cont, void *cont_cls);
-
-
-/**
- * Options for routing.
- */
-enum GNUNET_DHT_RouteOption
-  {
-    /**
-     * Default.  Do nothing special.
-     */
-    GNUNET_DHT_RO_NONE = 0,
-
-    /**
-     * Each peer along the way should look at 'enc' (otherwise
-     * only the k-peers closest to the key should look at it).
-     */
-    GNUNET_DHT_RO_DEMULTIPLEX_EVERYWHERE = 1
-  };
-
-
-/**
- * Iterator called on each result obtained from a find peer
- * operation
- *
- * @param cls closure
- * @param reply response
- */
-typedef void (*GNUNET_DHT_FindPeerProcessor)(void *cls,
-                                         const struct GNUNET_PeerIdentity *peer,
-                                         const struct GNUNET_MessageHeader *reply);
-
-
-/**
- * Perform an asynchronous FIND PEER operation on the DHT.
- *
- * @param handle handle to the DHT service
- * @param timeout timeout for this request to be sent to the
- *        service
- * @param options routing options for this message
- * @param message a message to inject at found peers (may be null)
- * @param key the key to look up
- * @param proc function to call on each result
- * @param proc_cls closure for proc
- * @param cont continuation to call once message sent
- * @param cont_cls closure for continuation

  *
  *

- * @return handle to stop the async get, NULL on error
+ * On return get_handle will no longer be valid, caller
+ * must not use again!!!

  */
  */

-struct GNUNET_DHT_FindPeerHandle *
-GNUNET_DHT_find_peer_start (struct GNUNET_DHT_Handle *handle,
-                      struct GNUNET_TIME_Relative timeout,
-                      enum GNUNET_DHT_RouteOption options,
-                      struct GNUNET_MessageHeader *message,
-                      const GNUNET_HashCode * key,
-                      GNUNET_DHT_FindPeerProcessor proc,
-                      void *proc_cls,
-                      GNUNET_SCHEDULER_Task cont,
-                      void *cont_cls);
-
-/**
- * Stop async find peer.  Frees associated resources.
- *
- * @param find_peer_handle GET operation to stop.
- */
-void
-GNUNET_DHT_find_peer_stop (struct GNUNET_DHT_FindPeerHandle *find_peer_handle, GNUNET_SCHEDULER_Task cont, void *cont_cls);
-
-/**
- * Iterator called on each result obtained from a generic route
- * operation
- */
-typedef void (*GNUNET_DHT_ReplyProcessor)(void *cls,
-                                          const struct GNUNET_MessageHeader *reply);
-
-/**
- * Perform an asynchronous FIND_PEER operation on the DHT.
- *
- * @param handle handle to the DHT service
- * @param key the key to look up
- * @param desired_replication_level how many peers should ultimately receive
- *                this message (advisory only, target may be too high for the
- *                given DHT or not hit exactly).
- * @param options options for routing
- * @param enc send the encapsulated message to a peer close to the key
- * @param timeout when to abort with an error if we fail to get
- *                a confirmation for the request (when necessary) or how long
- *                to wait for transmission to the service
- * @param iter function to call on each result, NULL if no replies are expected
- * @param iter_cls closure for iter
-
- * @param cont continuation to call when done, GNUNET_SYSERR if failed
- *             GNUNET_OK otherwise
- * @param cont_cls closure for cont
- * @return handle to stop the request
- */
-struct GNUNET_DHT_RouteHandle *
-GNUNET_DHT_route_start (struct GNUNET_DHT_Handle *handle,
-                       const GNUNET_HashCode *key,
-                       unsigned int desired_replication_level,
-                       enum GNUNET_DHT_RouteOption options,
-                       const struct GNUNET_MessageHeader *enc,
-                       struct GNUNET_TIME_Relative timeout,
-                       GNUNET_DHT_ReplyProcessor iter,
-                       void *iter_cls,
-                       GNUNET_SCHEDULER_Task cont,
-                       void *cont_cls);
-

 void
 void

-GNUNET_DHT_route_stop (struct GNUNET_DHT_RouteHandle *route_handle, GNUNET_SCHEDULER_Task cont, void *cont_cls);
+GNUNET_DHT_get_stop (struct GNUNET_DHT_GetHandle *get_handle);

 
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */