X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/6fba990cea5342a2101b4acceb5c9ee02cb87c92..0e2b222fc14b8f890fab644118cf0f43abbe450a:/lib/addr.c

diff --git a/lib/addr.c b/lib/addr.c
index f1f1c21..c0bc190 100644
--- a/lib/addr.c
+++ b/lib/addr.c
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004 Richard Kettlewell
+ * Copyright (C) 2004, 2007, 2008 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,7 +17,8 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
-/** @file lib/addr.c Socket address support */
+/** @file lib/addr.c
+ * @brief Socket address support */
 
 #include <config.h>
 #include "types.h"
@@ -104,7 +105,7 @@ int addrinfocmp(const struct addrinfo *a,
   if(a->ai_family != b->ai_family) return a->ai_family - b->ai_family;
   if(a->ai_socktype != b->ai_socktype) return a->ai_socktype - b->ai_socktype;
   if(a->ai_protocol != b->ai_protocol) return a->ai_protocol - b->ai_protocol;
-  switch(a->ai_protocol) {
+  switch(a->ai_family) {
   case PF_INET:
     ina = (const struct sockaddr_in *)a->ai_addr;
     inb = (const struct sockaddr_in *)b->ai_addr;
@@ -124,10 +125,12 @@ int addrinfocmp(const struct addrinfo *a,
   }
 }
 
-static inline int multicast4(const struct sockaddr_in *sin) {
-  return IN_MULTICAST(ntohl(sin->sin_addr.s_addr));
+/** @brief Return nonzero if @p sin4 is an IPv4 multicast address */
+static inline int multicast4(const struct sockaddr_in *sin4) {
+  return IN_MULTICAST(ntohl(sin4->sin_addr.s_addr));
 }
 
+/** @brief Return nonzero if @p sin6 is an IPv6 multicast address */
 static inline int multicast6(const struct sockaddr_in6 *sin6) {
   return IN6_IS_ADDR_MULTICAST(&sin6->sin6_addr);
 }
@@ -144,21 +147,23 @@ int multicast(const struct sockaddr *sa) {
   }
 }
 
-static inline char *format_sockaddr4(const struct sockaddr_in *sin) {
+/** @brief Format an IPv4 address */
+static inline char *format_sockaddr4(const struct sockaddr_in *sin4) {
   char buffer[1024], *r;
 
-  if(sin->sin_port)
+  if(sin4->sin_port)
     byte_xasprintf(&r, "%s port %u",
-		   inet_ntop(sin->sin_family, &sin->sin_addr,
+		   inet_ntop(sin4->sin_family, &sin4->sin_addr,
 			     buffer, sizeof buffer),
-		   ntohs(sin->sin_port));
+		   ntohs(sin4->sin_port));
   else
     byte_xasprintf(&r, "%s",
-		   inet_ntop(sin->sin_family, &sin->sin_addr,
+		   inet_ntop(sin4->sin_family, &sin4->sin_addr,
 			     buffer, sizeof buffer));
   return r;
 }
 
+/** @brief Format an IPv6 address */
 static inline char *format_sockaddr6(const struct sockaddr_in6 *sin6) {
   char buffer[1024], *r;
 
@@ -174,11 +179,15 @@ static inline char *format_sockaddr6(const struct sockaddr_in6 *sin6) {
   return r;
 }
 
+/** @brief Format a UNIX socket address */
 static inline char *format_sockaddrun(const struct sockaddr_un *sun) {
   return xstrdup(sun->sun_path);
 }
     
-/** @brief Construct a text description a sockaddr */
+/** @brief Construct a text description a sockaddr
+ * @param sa Socket address
+ * @return Human-readable form of address
+ */
 char *format_sockaddr(const struct sockaddr *sa) {
   switch(sa->sa_family) {
   case AF_INET: