extend API to enalbe exclusive port ranges to be specified for testing-system objects

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

diff --git a/src/include/gnunet_gns_service.h b/src/include/gnunet_gns_service.h
index 91df6373d3bf69e88e9b3ab8f743b9d3ae32d802..fcb71fa6fac71008b1091b0886fd7056e17f2174 100644 (file)
--- a/src/include/gnunet_gns_service.h
+++ b/src/include/gnunet_gns_service.h
@@ -23,10 +23,6 @@
  * @brief API to the GNS service
  * @author Martin Schanzenbach
  *
- * TODO:
- * - decide what goes into storage API and what into GNS-service API
- * - decide where to pass/expose/check keys / signatures
- * - are GNS private keys per peer or per user?
  */
 
 
@@ -52,13 +48,19 @@ extern "C"
 struct GNUNET_GNS_Handle;
 
 /**
- * Handle to control a get operation.
+ * Handle to control a lookup operation.
  */
-struct GNUNET_GNS_LookupHandle;
+struct GNUNET_GNS_LookupRequest;
 
 /**
- * Handle to control a shorten operation
+ * Handle to control a shorten operation.
  */
+struct GNUNET_GNS_ShortenRequest;
+
+/**
+ * Handle to control a get authority operation
+ */
+struct GNUNET_GNS_GetAuthRequest;
 
 /**
  * Record types
@@ -110,6 +112,7 @@ enum GNUNET_GNS_RecordType
   GNUNET_GNS_RECORD_REV  = GNUNET_NAMESTORE_TYPE_REV
 };
 
+
 /**
  * Initialize the connection with the GNS service.
  *
@@ -137,13 +140,12 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
  * lookup
  *
  * @param cls closure
- * @param name "name" of the original lookup
  * @param rd_count number of records
  * @param rd the records in reply
  */
 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
-                                 uint32_t rd_count,
-                                 const struct GNUNET_NAMESTORE_RecordData *rd);
+                                                 uint32_t rd_count,
+                                                 const struct GNUNET_NAMESTORE_RecordData *rd);
 
 
 
@@ -163,12 +165,13 @@ typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
  */
 struct GNUNET_GNS_LookupRequest*
 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
-                         const char * name,
-                         enum GNUNET_GNS_RecordType type,
-                         int only_cached,
-                         struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
-                         GNUNET_GNS_LookupResultProcessor proc,
-                         void *proc_cls);
+                  const char * name,
+                  enum GNUNET_GNS_RecordType type,
+                  int only_cached,
+                  struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
+                  GNUNET_GNS_LookupResultProcessor proc,
+                  void *proc_cls);
+
 
 /**
  * Perform an asynchronous lookup operation on the GNS
@@ -187,13 +190,13 @@ GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
  */
 struct GNUNET_GNS_LookupRequest*
 GNUNET_GNS_lookup_zone (struct GNUNET_GNS_Handle *handle,
-                         const char * name,
-                         struct GNUNET_CRYPTO_ShortHashCode *zone,
-                         enum GNUNET_GNS_RecordType type,
-                         int only_cached,
-                         struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
-                         GNUNET_GNS_LookupResultProcessor proc,
-                         void *proc_cls);
+                       const char * name,
+                       struct GNUNET_CRYPTO_ShortHashCode *zone,
+                       enum GNUNET_GNS_RecordType type,
+                       int only_cached,
+                       struct GNUNET_CRYPTO_RsaPrivateKey *shorten_key,
+                       GNUNET_GNS_LookupResultProcessor proc,
+                       void *proc_cls);
 
 
 /**
@@ -215,7 +218,7 @@ GNUNET_GNS_cancel_lookup_request (struct GNUNET_GNS_LookupRequest *lr);
  * @param short_name the shortened name or NULL if no result
  */
 typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
-                                        const char* short_name);
+                                                  const char* short_name);
 
 
 /**
@@ -268,6 +271,7 @@ GNUNET_GNS_shorten_zone (struct GNUNET_GNS_Handle *handle,
 void
 GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr);
 
+
 /* *************** Standard API: get authority ******************* */
 
 
@@ -279,7 +283,7 @@ GNUNET_GNS_cancel_shorten_request (struct GNUNET_GNS_ShortenRequest *sr);
  * @param auth_name the name of the auhtority or NULL
  */
 typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
-                                        const char* short_name);
+                                                  const char* short_name);
 
 
 /**
@@ -293,9 +297,9 @@ typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
  */
 struct GNUNET_GNS_GetAuthRequest*
 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
-                    const char * name,
-                    GNUNET_GNS_GetAuthResultProcessor proc,
-                    void *proc_cls);
+                         const char * name,
+                         GNUNET_GNS_GetAuthResultProcessor proc,
+                         void *proc_cls);
 
 
 /**
@@ -304,7 +308,7 @@ GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
  * @param gar the lookup request to cancel
  */
 void
-GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar)
+GNUNET_GNS_cancel_get_auth_request (struct GNUNET_GNS_GetAuthRequest *gar);
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {