SET service: accurate results for symmetric mode

[oweals/gnunet.git] / src / include / gnunet_resolver_service.h

diff --git a/src/include/gnunet_resolver_service.h b/src/include/gnunet_resolver_service.h
index ae98bb8a6f2da0fd00f2bf44a62146d57000d6fb..bb63fb86f385287772d9484f55c1042ecf205d75 100644 (file)
--- a/src/include/gnunet_resolver_service.h
+++ b/src/include/gnunet_resolver_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2001-2013 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
@@ -14,14 +14,16 @@
 
      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
@@ -45,11 +47,12 @@ extern "C"
  *
  * @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);
 
 
 /**
@@ -80,12 +83,13 @@ GNUNET_RESOLVER_disconnect (void);
  * @param hostname the hostname to resolve
  * @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 (const char *hostname, int af,
+GNUNET_RESOLVER_ip_get (const char *hostname,
+                        int af,
                         struct GNUNET_TIME_Relative timeout,
                         GNUNET_RESOLVER_AddressCallback callback,
                         void *callback_cls);
@@ -96,7 +100,7 @@ GNUNET_RESOLVER_ip_get (const char *hostname, int af,
  *
  * @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
  */
@@ -114,8 +118,9 @@ GNUNET_RESOLVER_hostname_resolve (int af,
  * @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 fully qualified domain name
@@ -130,15 +135,16 @@ GNUNET_RESOLVER_local_fqdn_get (void);
  * Perform a reverse DNS lookup.
  *
  * @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 (const struct sockaddr *sa, socklen_t salen,
+GNUNET_RESOLVER_hostname_get (const struct sockaddr *sa,
+                              socklen_t salen,
                               int do_resolve,
                               struct GNUNET_TIME_Relative timeout,
                               GNUNET_RESOLVER_HostnameCallback callback,
@@ -164,6 +170,8 @@ GNUNET_RESOLVER_request_cancel (struct GNUNET_RESOLVER_RequestHandle *rh);
 }
 #endif
 
+/** @} */ /* end of group resolver */
+
 /* ifndef GNUNET_RESOLVER_SERVICE_H */
 #endif
 /* end of gnunet_resolver_service.h */