- fixed string to address parsing

[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 70931b85da0a004f4853efb1ecfc46e58d0aa1dd..5528532cdf06e628717ce6e4bdd5a88067a0e78b 100644 (file)
--- a/src/include/gnunet_gns_service.h
+++ b/src/include/gnunet_gns_service.h
@@ -34,6 +34,7 @@
 #define GNUNET_GNS_SERVICE_H
 
 #include "gnunet_util_lib.h"
+#include "gnunet_dnsparser_lib.h"
 #include "gnunet_namestore_service.h"
 
 #ifdef __cplusplus
@@ -55,6 +56,10 @@ struct GNUNET_GNS_Handle;
  */
 struct GNUNET_GNS_LookupHandle;
 
+/**
+ * Handle to control a shorten operation
+ */
+
 /**
  * Record types
  * Based on GNUNET_DNSPARSER_TYPEs (standard DNS)
@@ -73,20 +78,19 @@ 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.
- * FIXME: Do we need the ht_len?
  *
  * @param cfg configuration to use
- * @param ht_len size of the internal hash table to use for parallel lookups
- * @return NULL on error
+ *
+ * @return handle to the GNS service, or NULL on error
  */
 struct GNUNET_GNS_Handle *
-GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                    unsigned int ht_len);
+GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
 /**
@@ -101,18 +105,17 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
 /* *************** Standard API: lookup ******************* */
 
 /**
- * Iterator called on each result obtained for a GNS
+ * Iterator called on obtained result for a GNS
  * lookup
  *
  * @param cls closure
  * @param name "name" of the original lookup
- * @param record the records in reply
- * @param num_records the number of records in reply
+ * @param rd_count number of records
+ * @param rd the records in reply
  */
-typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
-                                        const char * name,
-                                        const struct GNUNET_NAMESTORE_RecordData *record,
-                                        unsigned int num_records);
+typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
+                                 uint32_t rd_count,
+                                 const struct GNUNET_NAMESTORE_RecordData *rd);
 
 
 
@@ -120,36 +123,80 @@ typedef void (*GNUNET_GNS_LookupIterator) (void *cls,
  * Perform an asynchronous lookup operation on the GNS.
  *
  * @param handle handle to the GNS service
- * @param timeout how long to wait for transmission of this request to the service
- * // FIXME: what happens afterwards?
  * @param name the name to look up
  * @param type the GNUNET_GNS_RecordType to look for
- * @param iter function to call on each result
- * @param iter_cls closure for iter
+ * @param proc function to call on result
+ * @param proc_cls closure for processor
  *
- * @return handle to stop the async lookup
+ * @return handle to the queued request
  */
-struct GNUNET_GNS_LookupHandle *
-GNUNET_GNS_lookup_start (struct GNUNET_GNS_Handle *handle,
-                         struct GNUNET_TIME_Relative timeout,
+struct GNUNET_GNS_QueueEntry *
+GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
                          const char * name,
                          enum GNUNET_GNS_RecordType type,
-                         GNUNET_GNS_LookupIterator iter,
-                         void *iter_cls);
+                         GNUNET_GNS_LookupResultProcessor proc,
+                         void *proc_cls);
+
+
+/* *************** Standard API: shorten ******************* */
 
 
 /**
- * Stop async GNS lookup.  Frees associated resources.
+ * Processor called on for a name shortening result
+ * called only once
  *
- * @param lookup_handle lookup operation to stop.
+ * @param cls closure
+ * @param short_name the shortened name or NULL if no result
+ */
+typedef void (*GNUNET_GNS_ShortenResultProcessor) (void *cls,
+                                        const char* short_name);
+
+
+/**
+ * Perform a name shortening operation on the GNS.
  *
- * On return lookup_handle will no longer be valid, caller
- * must not use again!!!
+ * @param handle handle to the GNS service
+ * @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
  */
-void
-GNUNET_GNS_lookup_stop (struct GNUNET_GNS_LookupHandle *lookup_handle);
+struct GNUNET_GNS_QueueEntry *
+GNUNET_GNS_shorten (struct GNUNET_GNS_Handle *handle,
+                    const char * name,
+                    GNUNET_GNS_ShortenResultProcessor proc,
+                    void *proc_cls);
 
 
+/* *************** Standard API: get authority ******************* */
+
+
+/**
+ * Processor called on for a name shortening result
+ * called only once
+ *
+ * @param cls closure
+ * @param auth_name the name of the auhtority or NULL
+ */
+typedef void (*GNUNET_GNS_GetAuthResultProcessor) (void *cls,
+                                        const char* short_name);
+
+
+/**
+ * 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 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 *proc_cls);
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif