src/include/gnunet_gns_service.h

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2012-2014 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., 51 Franklin Street, Fifth Floor,
  18       Boston, MA 02110-1301, USA.
  19  */
  20
  21 /**
  22  * @file include/gnunet_gns_service.h
  23  * @brief API to the GNS service
  24  * @author Martin Schanzenbach
  25  */
  26 #ifndef GNUNET_GNS_SERVICE_H
  27 #define GNUNET_GNS_SERVICE_H
  28
  29 #include "gnunet_util_lib.h"
  30 #include "gnunet_dnsparser_lib.h"
  31 #include "gnunet_namestore_service.h"
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #if 0                           /* keep Emacsens' auto-indent happy */
  37 }
  38 #endif
  39 #endif
  40
  41
  42 /**
  43  * String we use to indicate the local master zone or a
  44  * root entry in the current zone.
  45  */
  46 #define GNUNET_GNS_MASTERZONE_STR "+"
  47
  48 /**
  49  * Connection to the GNS service.
  50  */
  51 struct GNUNET_GNS_Handle;
  52
  53 /**
  54  * Handle to control a lookup operation.
  55  */
  56 struct GNUNET_GNS_LookupRequest;
  57
  58
  59 /**
  60  * Initialize the connection with the GNS service.
  61  *
  62  * @param cfg configuration to use
  63  * @return handle to the GNS service, or NULL on error
  64  */
  65 struct GNUNET_GNS_Handle *
  66 GNUNET_GNS_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  67
  68
  69 /**
  70  * Shutdown connection with the GNS service.
  71  *
  72  * @param handle connection to shut down
  73  */
  74 void
  75 GNUNET_GNS_disconnect (struct GNUNET_GNS_Handle *handle);
  76
  77
  78 /**
  79  * Iterator called on obtained result for a GNS lookup.
  80  *
  81  * @param cls closure
  82  * @param rd_count number of records in @a rd
  83  * @param rd the records in reply
  84  */
  85 typedef void (*GNUNET_GNS_LookupResultProcessor) (void *cls,
  86                                                   uint32_t rd_count,
  87                                                   const struct GNUNET_GNSRECORD_Data *rd);
  88
  89
  90 /**
  91  * Options for the GNS lookup.
  92  */
  93 enum GNUNET_GNS_LocalOptions
  94 {
  95   /**
  96    * Defaults, look in cache, then in DHT.
  97    */
  98   GNUNET_GNS_LO_DEFAULT = 0,
  99
 100   /**
 101    * Never look in the DHT, keep request to local cache.
 102    */
 103   GNUNET_GNS_LO_NO_DHT = 1,
 104
 105   /**
 106    * For the rightmost label, only look in the cache (it
 107    * is our master zone), for the others, the DHT is OK.
 108    */
 109   GNUNET_GNS_LO_LOCAL_MASTER = 2
 110
 111 };
 112
 113
 114 /**
 115  * Perform an asynchronous lookup operation on the GNS.
 116  *
 117  * @param handle handle to the GNS service
 118  * @param name the name to look up
 119  * @param zone zone to look in
 120  * @param type the GNS record type to look for
 121  * @param options local options for the lookup
 122  * @param shorten_zone_key the private key of the shorten zone (can be NULL);
 123  *                    specify to enable automatic shortening (given a PSEU
 124  *                    record, if a given pseudonym is not yet used in the
 125  *                    shorten zone, we automatically add the respective zone
 126  *                    under that name)
 127  * @param proc function to call on result
 128  * @param proc_cls closure for processor
 129  * @return handle to the queued request
 130  */
 131 struct GNUNET_GNS_LookupRequest *
 132 GNUNET_GNS_lookup (struct GNUNET_GNS_Handle *handle,
 133                    const char *name,
 134                    const struct GNUNET_CRYPTO_EcdsaPublicKey *zone,
 135                    uint32_t type,
 136                    enum GNUNET_GNS_LocalOptions options,
 137                    const struct GNUNET_CRYPTO_EcdsaPrivateKey *shorten_zone_key,
 138                    GNUNET_GNS_LookupResultProcessor proc,
 139                    void *proc_cls);
 140
 141
 142 /**
 143  * Cancel pending lookup request
 144  *
 145  * @param lr the lookup request to cancel
 146  */
 147 void
 148 GNUNET_GNS_lookup_cancel (struct GNUNET_GNS_LookupRequest *lr);
 149
 150
 151 #if 0                           /* keep Emacsens' auto-indent happy */
 152 {
 153 #endif
 154 #ifdef __cplusplus
 155 }
 156 #endif
 157
 158
 159 #endif
 160 /* gnunet_gns_service.h */