src/include/gnunet_gns_service.h

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