Merge branch 'master' of ssh://gnunet.org/gnunet

[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 f26b44265e96c25291ec23ac94b26c505e9091d2..ccc868c056dac1e11d127b9403534dd6905e0e43 100644 (file)
--- a/src/include/gnunet_gns_service.h
+++ b/src/include/gnunet_gns_service.h
@@ -1,6 +1,6 @@
 /*
       This file is part of GNUnet
-      (C) 2012-2013 Christian Grothoff (and other contributing authors)
+      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
@@ -14,14 +14,22 @@
 
       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., 59 Temple Place - Suite 330,
-      Boston, MA 02111-1307, USA.
+      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+      Boston, MA 02110-1301, USA.
  */
 
 /**
- * @file include/gnunet_gns_service.h
- * @brief API to the GNS service
  * @author Martin Schanzenbach
+ *
+ * @file
+ * API to the GNS service
+ *
+ * @defgroup gns  GNS service
+ * GNU Name System
+ *
+ * @see [Documentation](https://gnunet.org/gns-implementation)
+ *
+ * @{
  */
 #ifndef GNUNET_GNS_SERVICE_H
 #define GNUNET_GNS_SERVICE_H
@@ -82,9 +90,34 @@ 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_NAMESTORE_RecordData *rd);
+typedef void
+(*GNUNET_GNS_LookupResultProcessor) (void *cls,
+                                     uint32_t rd_count,
+                                     const struct GNUNET_GNSRECORD_Data *rd);
+
+
+/**
+ * Options for the GNS lookup.
+ */
+enum GNUNET_GNS_LocalOptions
+{
+  /**
+   * Defaults, look in cache, then in DHT.
+   */
+  GNUNET_GNS_LO_DEFAULT = 0,
+
+  /**
+   * Never look in the DHT, keep request to local cache.
+   */
+  GNUNET_GNS_LO_NO_DHT = 1,
+
+  /**
+   * For the rightmost label, only look in the cache (it
+   * is our master zone), for the others, the DHT is OK.
+   */
+  GNUNET_GNS_LO_LOCAL_MASTER = 2
+
+};
 
 
 /**
@@ -94,23 +127,17 @@ typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
  * @param name the name to look up
  * @param zone zone to look in
  * @param type the GNS record type to look for
- * @param only_cached #GNUNET_YES to only check locally (not in the DHT)
- * @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 options local options for the lookup
  * @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 *
 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
                   const char *name,
                   const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
-                  int type,
-                  int only_cached,
-                  const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_zone_key,
+                  uint32_t type,
+                  enum GNUNET_GNS_LocalOptions options,
                   GNUNET_GNS_LookupResultProcessor proc,
                   void *proc_cls);
 
@@ -131,6 +158,6 @@ GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
 }
 #endif
 
-
 #endif
-/* gnunet_gns_service.h */
+
+/** @} */  /* end of group */