/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2001-2013 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 2, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
* @file include/gnunet_resolver_service.h
* @brief functions related to doing DNS lookups
* @author Christian Grothoff
+ * @defgroup resolver asynchronous standard DNS lookups
+ * @{
*/
#ifndef GNUNET_RESOLVER_SERVICE_H
*
* @param cls closure
* @param addr one of the addresses of the host, NULL for the last address
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
*/
-typedef void (*GNUNET_RESOLVER_AddressCallback) (void *cls,
- const struct sockaddr * addr,
- socklen_t addrlen);
+typedef void
+(*GNUNET_RESOLVER_AddressCallback) (void *cls,
+ const struct sockaddr *addr,
+ socklen_t addrlen);
/**
*/
struct GNUNET_RESOLVER_RequestHandle;
+/**
+ * Create the connection to the resolver service.
+ *
+ * @param cfg configuration to use
+ */
+void
+GNUNET_RESOLVER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Destroy the connection to the resolver service.
+ */
+void
+GNUNET_RESOLVER_disconnect (void);
+
/**
* Convert a string to one or more IP addresses.
*
- * @param sched scheduler to use
- * @param cfg configuration to use
* @param hostname the hostname to resolve
- * @param domain AF_INET or AF_INET6; use AF_UNSPEC for "any"
+ * @param af AF_INET or AF_INET6; use AF_UNSPEC for "any"
* @param callback function to call with addresses
- * @param callback_cls closure for callback
+ * @param callback_cls closure for @a callback
* @param timeout how long to try resolving
* @return handle that can be used to cancel the request, NULL on error
*/
struct GNUNET_RESOLVER_RequestHandle *
-GNUNET_RESOLVER_ip_get (struct GNUNET_SCHEDULER_Handle *sched,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *hostname,
- int domain,
+GNUNET_RESOLVER_ip_get (const char *hostname,
+ int af,
struct GNUNET_TIME_Relative timeout,
- GNUNET_RESOLVER_AddressCallback callback,
- void *callback_cls);
+ GNUNET_RESOLVER_AddressCallback callback,
+ void *callback_cls);
/**
* Resolve our hostname to an IP address.
*
- * @param sched scheduler to use
- * @param cfg configuration to use
- * @param domain AF_INET or AF_INET6; use AF_UNSPEC for "any"
+ * @param af AF_INET or AF_INET6; use AF_UNSPEC for "any"
* @param callback function to call with addresses
- * @param cls closure for callback
+ * @param cls closure for @a callback
* @param timeout how long to try resolving
* @return handle that can be used to cancel the request, NULL on error
*/
struct GNUNET_RESOLVER_RequestHandle *
-GNUNET_RESOLVER_hostname_resolve (struct GNUNET_SCHEDULER_Handle *sched,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- int domain,
+GNUNET_RESOLVER_hostname_resolve (int af,
struct GNUNET_TIME_Relative timeout,
GNUNET_RESOLVER_AddressCallback callback,
void *cls);
* @param hostname one of the names for the host, NULL
* on the last call to the callback
*/
-typedef void (*GNUNET_RESOLVER_HostnameCallback) (void *cls,
- const char *hostname);
+typedef void
+(*GNUNET_RESOLVER_HostnameCallback) (void *cls,
+ const char *hostname);
/**
- * Get local hostname
+ * Get local fully qualified domain name
*
- * @param hostname
+ * @return local hostname, caller must free
*/
char *
-GNUNET_RESOLVER_local_hostname_get ();
+GNUNET_RESOLVER_local_fqdn_get (void);
+
/**
* Perform a reverse DNS lookup.
*
- * @param sched scheduler to use
- * @param cfg configuration to use
* @param sa host address
- * @param salen length of host address
- * @param do_resolve use GNUNET_NO to return numeric hostname
+ * @param salen length of @a sa
+ * @param do_resolve use #GNUNET_NO to return numeric hostname
* @param timeout how long to try resolving
* @param callback function to call with hostnames
- * @param cls closure for callback
+ * @param cls closure for @a callback
* @return handle that can be used to cancel the request, NULL on error
*/
-struct GNUNET_RESOLVER_RequestHandle *
-GNUNET_RESOLVER_hostname_get (struct GNUNET_SCHEDULER_Handle *sched,
- const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct sockaddr *sa,
- socklen_t salen,
- int do_resolve,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_RESOLVER_HostnameCallback callback,
- void *cls);
+struct GNUNET_RESOLVER_RequestHandle *
+GNUNET_RESOLVER_hostname_get (const struct sockaddr *sa,
+ socklen_t salen,
+ int do_resolve,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_RESOLVER_HostnameCallback callback,
+ void *cls);
/**
* been completed (i.e, the callback has been called to
* signal timeout or the final result).
*
- * @param h handle of request to cancel
+ * @param rh handle of request to cancel
*/
void
-GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *h);
+GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh);
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
+/** @} */ /* end of group resolver */
+
/* ifndef GNUNET_RESOLVER_SERVICE_H */
#endif
/* end of gnunet_resolver_service.h */
projects / oweals / gnunet.git / blobdiff