curl: reschedule uses GNUNET_CURL_perform2.
[oweals/gnunet.git] / src / include / gnunet_gns_service.h
index 8a1099444075b367477cd605605a0361eaa19136..b6fac6111b3a2c2dbc5f3d508f271977fc440dc1 100644 (file)
@@ -1,21 +1,19 @@
 /*
       This file is part of GNUnet
-      Copyright (C) 2012-2014 GNUnet e.V.
+      Copyright (C) 2012-2014, 2017 GNUnet e.V.
 
-      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 3, or (at your
-      option) any later version.
+      GNUnet is free software: you can redistribute it and/or modify it
+      under the terms of the GNU Affero General Public License as published
+      by the Free Software Foundation, either version 3 of the License,
+      or (at your option) any later version.
 
       GNUnet is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-      General Public License for more details.
-
-      You should have received a copy of the GNU General Public License
-      along with GNUnet; see the file COPYING.  If not, write to the
-      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-      Boston, MA 02110-1301, USA.
+      Affero General Public License for more details.
+     
+      You should have received a copy of the GNU Affero General Public License
+      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /**
@@ -48,10 +46,10 @@ extern "C"
 
 
 /**
- * String we use to indicate the local master zone or a
- * root entry in the current zone.
+ * String we use to indicate an empty label (top-level
+ * entry in the zone).  DNS uses "@", so do we.
  */
-#define GNUNET_GNS_MASTERZONE_STR "+"
+#define GNUNET_GNS_EMPTY_LABEL_AT "@"
 
 /**
  * Connection to the GNS service.
@@ -63,6 +61,12 @@ struct GNUNET_GNS_Handle;
  */
 struct GNUNET_GNS_LookupRequest;
 
+/**
+ * Handle to control a lookup operation where the
+ * TLD is resolved to a zone as part of the lookup operation.
+ */
+struct GNUNET_GNS_LookupWithTldRequest;
+
 
 /**
  * Initialize the connection with the GNS service.
@@ -90,19 +94,10 @@ GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
  * @param rd_count number of records in @a rd
  * @param rd the records in reply
  */
-typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
-                                                 uint32_t rd_count,
-                                                 const struct GNUNET_GNSRECORD_Data *rd);
-
-/**
- * Iterator called on obtained result for a GNS lookup.
- *
- * @param cls closure
- * @param rd_count number of records in @a rd
- * @param rd the records in reply
- */
-typedef void (*GNUNET_GNS_ReverseLookupResultProcessor) (void *cls,
-                                                 const char* name);
+typedef void
+(*GNUNET_GNS_LookupResultProcessor) (void *cls,
+                                     uint32_t rd_count,
+                                     const struct GNUNET_GNSRECORD_Data *rd);
 
 
 /**
@@ -122,7 +117,7 @@ enum GNUNET_GNS_LocalOptions
 
   /**
    * For the rightmost label, only look in the cache (it
-   * is our master zone), for the others, the DHT is OK.
+   * is our local namestore), for the others, the DHT is OK.
    */
   GNUNET_GNS_LO_LOCAL_MASTER = 2
 
@@ -137,13 +132,8 @@ enum GNUNET_GNS_LocalOptions
  * @param zone zone to look in
  * @param type the GNS record type to look for
  * @param options local options for the lookup
- * @param shorten_zone_key the private key of the shorten zone (can be NULL);
- *                    specify to enable automatic shortening (given a PSEU
- *                    record, if a given pseudonym is not yet used in the
- *                    shorten zone, we automatically add the respective zone
- *                    under that name)
  * @param proc function to call on result
- * @param proc_cls closure for processor
+ * @param proc_cls closure for @a proc
  * @return handle to the queued request
  */
 struct GNUNET_GNS_LookupRequest *
@@ -152,35 +142,67 @@ GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
                   const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
                   uint32_t type,
                   enum GNUNET_GNS_LocalOptions options,
-                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_zone_key,
                   GNUNET_GNS_LookupResultProcessor proc,
                   void *proc_cls);
 
+
 /**
- * Perform an asynchronous reverse lookup operation on the GNS.
+ * Cancel pending lookup request
+ *
+ * @param lr the lookup request to cancel
+ * @return closure from the lookup result processor
+ */
+void *
+GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
+
+
+/**
+ * Iterator called on obtained result for a GNS lookup
+ * where "not GNS" is a valid answer.
+ *
+ * @param cls closure
+ * @param gns_tld #GNUNET_YES if a GNS lookup was attempted,
+ *                #GNUNET_NO if the TLD is not configured for GNS
+ * @param rd_count number of records in @a rd
+ * @param rd the records in the reply
+ */
+typedef void
+(*GNUNET_GNS_LookupResultProcessor2) (void *cls,
+                                     int gns_tld,
+                                     uint32_t rd_count,
+                                     const struct GNUNET_GNSRECORD_Data *rd);
+
+
+/**
+ * Perform an asynchronous lookup operation on the GNS,
+ * determining the zone using the TLD of the given name
+ * and the current configuration to resolve TLDs to zones.
  *
  * @param handle handle to the GNS service
- * @param zone_key zone to find a name for
- * @param root_key our zone
+ * @param name the name to look up, including TLD
+ * @param type the record type to look up
+ * @param options local options for the lookup
  * @param proc processor to call on result
  * @param proc_cls closure for @a proc
- * @return handle to the request
+ * @return handle to the get request
  */
-struct GNUNET_GNS_ReverseLookupRequest*
-GNUNET_GNS_reverse_lookup (struct GNUNET_GNS_Handle *handle,
-                           const struct GNUNET_CRYPTO_EcdsaPublicKey *zone_key,
-                           const struct GNUNET_CRYPTO_EcdsaPublicKey *root_key,
-                           GNUNET_GNS_ReverseLookupResultProcessor proc,
-                           void *proc_cls);
+struct GNUNET_GNS_LookupWithTldRequest*
+GNUNET_GNS_lookup_with_tld (struct GNUNET_GNS_Handle *handle,
+                           const char *name,
+                           uint32_t type,
+                           enum GNUNET_GNS_LocalOptions options,
+                           GNUNET_GNS_LookupResultProcessor2 proc,
+                           void *proc_cls);
 
 
 /**
  * Cancel pending lookup request
  *
- * @param lr the lookup request to cancel
+ * @param ltr the lookup request to cancel
+ * @return closure from the lookup result processor
  */
-void
-GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
+void *
+GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */