src/include/gnunet_resolver_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 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 2, 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  */
  26
  27 #ifndef GNUNET_RESOLVER_SERVICE_H
  28 #define GNUNET_RESOLVER_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_configuration_lib.h"
  39 #include "gnunet_scheduler_lib.h"
  40 #include "gnunet_time_lib.h"
  41
  42
  43 /**
  44  * Function called by the resolver for each address obtained from DNS.
  45  *
  46  * @param cls closure
  47  * @param addr one of the addresses of the host, NULL for the last address
  48  * @param addrlen length of the address
  49  */
  50 typedef void (*GNUNET_RESOLVER_AddressCallback) (void *cls,
  51                                                  const struct sockaddr *addr,
  52                                                  socklen_t addrlen);
  53
  54
  55 /**
  56  * Handle to a request given to the resolver.  Can be used to cancel
  57  * the request prior to the timeout or successful execution.
  58  */
  59 struct GNUNET_RESOLVER_RequestHandle;
  60
  61 /**
  62  * Create the connection to the resolver service.
  63  *
  64  * @param cfg configuration to use
  65  */
  66 void
  67 GNUNET_RESOLVER_connect (const struct GNUNET_CONFIGURATION_Handle *c);
  68
  69
  70 /**
  71  * Destroy the connection to the resolver service.
  72  */
  73 void
  74 GNUNET_RESOLVER_disconnect (void);
  75
  76
  77 /**
  78  * Convert a string to one or more IP addresses.
  79  *
  80  * @param hostname the hostname to resolve
  81  * @param domain AF_INET or AF_INET6; use AF_UNSPEC for "any"
  82  * @param callback function to call with addresses
  83  * @param callback_cls closure for callback
  84  * @param timeout how long to try resolving
  85  * @return handle that can be used to cancel the request, NULL on error
  86  */
  87 struct GNUNET_RESOLVER_RequestHandle *
  88 GNUNET_RESOLVER_ip_get (const char *hostname,
  89                         int domain,
  90                         struct GNUNET_TIME_Relative timeout,
  91                         GNUNET_RESOLVER_AddressCallback callback,
  92                         void *callback_cls);
  93
  94
  95 /**
  96  * Resolve our hostname to an IP address.
  97  *
  98  * @param cfg configuration to use
  99  * @param domain AF_INET or AF_INET6; use AF_UNSPEC for "any"
 100  * @param callback function to call with addresses
 101  * @param cls closure for 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 domain,
 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 cfg configuration to use
 135  * @param sa host address
 136  * @param salen length of host address
 137  * @param do_resolve use GNUNET_NO to return numeric hostname
 138  * @param timeout how long to try resolving
 139  * @param callback function to call with hostnames
 140  * @param cls closure for callback
 141  * @return handle that can be used to cancel the request, NULL on error
 142  */
 143 struct GNUNET_RESOLVER_RequestHandle *
 144 GNUNET_RESOLVER_hostname_get (const struct sockaddr *sa,
 145                               socklen_t salen,
 146                               int do_resolve,
 147                               struct GNUNET_TIME_Relative timeout,
 148                               GNUNET_RESOLVER_HostnameCallback callback,
 149                               void *cls);
 150
 151
 152 /**
 153  * Cancel a request that is still pending with the resolver.
 154  * Note that a client MUST NOT cancel a request that has
 155  * been completed (i.e, the callback has been called to
 156  * signal timeout or the final result).
 157  *
 158  * @param rh handle of request to cancel
 159  */
 160 void
 161 GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh);
 162
 163
 164 #if 0                           /* keep Emacsens' auto-indent happy */
 165 {
 166 #endif
 167 #ifdef __cplusplus
 168 }
 169 #endif
 170
 171 /* ifndef GNUNET_RESOLVER_SERVICE_H */
 172 #endif
 173 /* end of gnunet_resolver_service.h */