/*
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
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
/**
* String we use to indicate the local master zone or a
* root entry in the current zone.
+ *
+ * FIXME: probably should be changed to "@" and renamed
+ * (this name is confusing!)
*/
#define GNUNET_GNS_MASTERZONE_STR "+"
*/
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.
* @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
+
+};
/**
* @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_EccPublicKey *zone,
- int type,
- int only_cached,
- const struct GNUNET_CRYPTO_EccPrivateKey *shorten_zone_key,
+ const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
+ uint32_t type,
+ enum GNUNET_GNS_LocalOptions options,
GNUNET_GNS_LookupResultProcessor proc,
void *proc_cls);
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 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 get request
+ */
+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 ltr the lookup request to cancel
+ */
+void
+GNUNET_GNS_lookup_with_tld_cancel (struct GNUNET_GNS_LookupWithTldRequest *ltr);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
}
#endif
-
#endif
-/* gnunet_gns_service.h */
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff