- fixed string to address parsing
[oweals/gnunet.git] / src / include / gnunet_gns_service.h
index 66cbab8209e327681faf7f6f9a23c852d7b32cd4..5528532cdf06e628717ce6e4bdd5a88067a0e78b 100644 (file)
@@ -78,14 +78,15 @@ enum GNUNET_GNS_RecordType
 
   /* GNS specific */
   GNUNET_GNS_RECORD_PKEY = GNUNET_NAMESTORE_TYPE_PKEY,
-  GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU
+  GNUNET_GNS_RECORD_PSEU = GNUNET_NAMESTORE_TYPE_PSEU,
+  GNUNET_GNS_RECORD_ANY  = GNUNET_NAMESTORE_TYPE_ANY
 };
 
 /**
  * Initialize the connection with the GNS service.
  *
  * @param cfg configuration to use
- * @param ht_len size of the internal hash table to use for parallel requests
+ *
  * @return handle to the GNS service, or NULL on error
  */
 struct GNUNET_GNS_Handle *
@@ -113,8 +114,8 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
  * @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);
 
 
 
@@ -125,7 +126,7 @@ typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
  * @param name the name to look up
  * @param type the GNUNET_GNS_RecordType to look for
  * @param proc function to call on result
- * @param proc_cls closure for iter
+ * @param proc_cls closure for processor
  *
  * @return handle to the queued request
  */
@@ -152,20 +153,19 @@ typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
 
 
 /**
- * Perform a shorten operation on name using the GNS.
+ * Perform a name shortening operation on the GNS.
  *
  * @param handle handle to the GNS service
- * @param name the name to shorten
- * @param proc processor to call on result
- * @param cls closure for processor
- *
- * @return handle to the shorten operation
+ * @param name the name to look up
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ * @return handle to the operation
  */
 struct GNUNET_GNS_QueueEntry *
 GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
-                         const char * name,
-                         GNUNET_GNS_ShortenResultProcessor proc,
-                         void *cls);
+                    const char * name,
+                    GNUNET_GNS_ShortenResultProcessor proc,
+                    void *proc_cls);
 
 
 /* *************** Standard API: get authority ******************* */
@@ -183,20 +183,19 @@ typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
 
 
 /**
- * Perform a shorten operation on name using the GNS.
+ * Perform an authority lookup for a given name.
  *
  * @param handle handle to the GNS service
  * @param name the name to look up authority for
- * @param proc processor to call on result
- * @param cls closure for processor
- *
- * @return handle to the get authority operation
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
+ * @return handle to the operation
  */
 struct GNUNET_GNS_QueueEntry *
 GNUNET_GNS_get_authority (struct GNUNET_GNS_Handle *handle,
-                         const char * name,
-                         GNUNET_GNS_GetAuthResultProcessor proc,
-                         void *cls);
+                    const char * name,
+                    GNUNET_GNS_GetAuthResultProcessor proc,
+                    void *proc_cls);
 
 #if 0                           /* keep Emacsens' auto-indent happy */
 {