src/include/gnunet_resolver_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001-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 /**
  22  * @file include/gnunet_resolver_service.h
  23  * @brief functions related to doing DNS lookups
  24  * @author Christian Grothoff
  25  * @defgroup resolver asynchronous standard DNS lookups
  26  * @{
  27  */
  28
  29 #ifndef GNUNET_RESOLVER_SERVICE_H
  30 #define GNUNET_RESOLVER_SERVICE_H
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 #include "gnunet_configuration_lib.h"
  41 #include "gnunet_scheduler_lib.h"
  42 #include "gnunet_time_lib.h"
  43
  44
  45 /**
  46  * Function called by the resolver for each address obtained from DNS.
  47  *
  48  * @param cls closure
  49  * @param addr one of the addresses of the host, NULL for the last address
  50  * @param addrlen length of @a addr
  51  */
  52 typedef void (*GNUNET_RESOLVER_AddressCallback) (void *cls,
  53                                                  const struct sockaddr *addr,
  54                                                  socklen_t addrlen);
  55
  56
  57 /**
  58  * Handle to a request given to the resolver.  Can be used to cancel
  59  * the request prior to the timeout or successful execution.
  60  */
  61 struct GNUNET_RESOLVER_RequestHandle;
  62
  63 /**
  64  * Create the connection to the resolver service.
  65  *
  66  * @param cfg configuration to use
  67  */
  68 void
  69 GNUNET_RESOLVER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
  70
  71
  72 /**
  73  * Destroy the connection to the resolver service.
  74  */
  75 void
  76 GNUNET_RESOLVER_disconnect (void);
  77
  78
  79 /**
  80  * Convert a string to one or more IP addresses.
  81  *
  82  * @param hostname the hostname to resolve
  83  * @param af AF_INET or AF_INET6; use AF_UNSPEC for "any"
  84  * @param callback function to call with addresses
  85  * @param callback_cls closure for @a callback
  86  * @param timeout how long to try resolving
  87  * @return handle that can be used to cancel the request, NULL on error
  88  */
  89 struct GNUNET_RESOLVER_RequestHandle *
  90 GNUNET_RESOLVER_ip_get (const char *hostname, int af,
  91                         struct GNUNET_TIME_Relative timeout,
  92                         GNUNET_RESOLVER_AddressCallback callback,
  93                         void *callback_cls);
  94
  95
  96 /**
  97  * Resolve our hostname to an IP address.
  98  *
  99  * @param af AF_INET or AF_INET6; use AF_UNSPEC for "any"
 100  * @param callback function to call with addresses
 101  * @param cls closure for @a callback
 102  * @param timeout how long to try resolving
 103  * @return handle that can be used to cancel the request, NULL on error
 104  */
 105 struct GNUNET_RESOLVER_RequestHandle *
 106 GNUNET_RESOLVER_hostname_resolve (int af,
 107                                   struct GNUNET_TIME_Relative timeout,
 108                                   GNUNET_RESOLVER_AddressCallback callback,
 109                                   void *cls);
 110
 111
 112 /**
 113  * Function called by the resolver for each hostname obtained from DNS.
 114  *
 115  * @param cls closure
 116  * @param hostname one of the names for the host, NULL
 117  *        on the last call to the callback
 118  */
 119 typedef void (*GNUNET_RESOLVER_HostnameCallback) (void *cls,
 120                                                   const char *hostname);
 121
 122 /**
 123  * Get local fully qualified domain name
 124  *
 125  * @return local hostname, caller must free
 126  */
 127 char *
 128 GNUNET_RESOLVER_local_fqdn_get (void);
 129
 130
 131 /**
 132  * Perform a reverse DNS lookup.
 133  *
 134  * @param sa host address
 135  * @param salen length of @a sa
 136  * @param do_resolve use #GNUNET_NO to return numeric hostname
 137  * @param timeout how long to try resolving
 138  * @param callback function to call with hostnames
 139  * @param cls closure for @a callback
 140  * @return handle that can be used to cancel the request, NULL on error
 141  */
 142 struct GNUNET_RESOLVER_RequestHandle *
 143 GNUNET_RESOLVER_hostname_get (const struct sockaddr *sa, socklen_t salen,
 144                               int do_resolve,
 145                               struct GNUNET_TIME_Relative timeout,
 146                               GNUNET_RESOLVER_HostnameCallback callback,
 147                               void *cls);
 148
 149
 150 /**
 151  * Cancel a request that is still pending with the resolver.
 152  * Note that a client MUST NOT cancel a request that has
 153  * been completed (i.e, the callback has been called to
 154  * signal timeout or the final result).
 155  *
 156  * @param rh handle of request to cancel
 157  */
 158 void
 159 GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh);
 160
 161
 162 #if 0                           /* keep Emacsens' auto-indent happy */
 163 {
 164 #endif
 165 #ifdef __cplusplus
 166 }
 167 #endif
 168
 169 /** @} */ /* end of group resolver */
 170
 171 /* ifndef GNUNET_RESOLVER_SERVICE_H */
 172 #endif
 173 /* end of gnunet_resolver_service.h */