src/gns/gnunet-service-gns_resolver.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2009-2013 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20 /**
  21  * @file gns/gnunet-service-gns_resolver.h
  22  * @brief GNUnet GNS service
  23  * @author Martin Schanzenbach
  24  */
  25 #ifndef GNS_RESOLVER_H
  26 #define GNS_RESOLVER_H
  27 #include "gns.h"
  28 #include "gnunet_dht_service.h"
  29 #include "gnunet_gns_service.h"
  30 #include "gnunet_namecache_service.h"
  31
  32 /**
  33  * Initialize the resolver subsystem.
  34  * MUST be called before #GNS_resolver_lookup.
  35  *
  36  * @param nc the namecache handle
  37  * @param dht handle to the dht
  38  * @param c configuration handle
  39  * @param max_bg_queries maximum amount of background queries
  40  */
  41 void
  42 GNS_resolver_init (struct GNUNET_NAMECACHE_Handle *nc,
  43                    struct GNUNET_DHT_Handle *dht,
  44                    const struct GNUNET_CONFIGURATION_Handle *c,
  45                    unsigned long long max_bg_queries);
  46
  47
  48 /**
  49  * Cleanup resolver: Terminate pending lookups
  50  */
  51 void
  52 GNS_resolver_done (void);
  53
  54
  55 /**
  56  * Handle for an active request.
  57  */
  58 struct GNS_ResolverHandle;
  59
  60
  61 /**
  62  * Function called with results for a GNS resolution.
  63  *
  64  * @param cls closure
  65  * @param rd_count number of records in @a rd
  66  * @param rd records returned for the lookup
  67  */
  68 typedef void (*GNS_ResultProcessor)(void *cls,
  69                                     uint32_t rd_count,
  70                                     const struct GNUNET_GNSRECORD_Data *rd);
  71
  72
  73 /**
  74  * Lookup of a record in a specific zone
  75  * calls RecordLookupProcessor on result or timeout
  76  *
  77  * @param zone the zone to perform the lookup in
  78  * @param record_type the record type to look up
  79  * @param name the name to look up
  80  * @param shorten_key optional private key for authority caching, can be NULL
  81  * @param options options set to control local lookup
  82  * @param proc the processor to call
  83  * @param proc_cls the closure to pass to @a proc
  84  * @return handle to cancel operation
  85  */
  86 struct GNS_ResolverHandle *
  87 GNS_resolver_lookup (const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
  88                      uint32_t record_type,
  89                      const char *name,
  90                      const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_key,
  91                      enum GNUNET_GNS_LocalOptions options,
  92                      GNS_ResultProcessor proc,
  93                      void *proc_cls);
  94
  95
  96 /**
  97  * Cancel active resolution (i.e. client disconnected).
  98  *
  99  * @param rh resolution to abort
 100  */
 101 void
 102 GNS_resolver_lookup_cancel (struct GNS_ResolverHandle *rh);
 103
 104
 105
 106
 107 /**
 108  * Generic function to check for TLDs.  Checks if "name" ends in ".tld"
 109  *
 110  * @param name the name to check
 111  * @param tld the tld to check
 112  * @return #GNUNET_YES or #GNUNET_NO
 113  */
 114 int
 115 is_tld (const char *name,
 116         const char *tld);
 117
 118
 119
 120 /**
 121  * Checks for gnu/zkey
 122  */
 123 #define is_gnu_tld(name) is_tld(name, GNUNET_GNS_TLD)
 124 #define is_zkey_tld(name) is_tld(name, GNUNET_GNS_TLD_ZKEY)
 125
 126
 127 #endif