X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fnet%2F_info;h=b4b219fd3599094a7195e9c1a83c24bc79a8c28f;hp=0b38c440061fd77776091e8813c26e10f14c4937;hb=158de63fda4e79ce3a632f25d444a1ec66f45d74;hpb=04a42d50a02645aca83d7dc02d8e9838540e818d;ds=inline

diff --git a/ccan/net/_info b/ccan/net/_info
index 0b38c440..b4b219fd 100644
--- a/ccan/net/_info
+++ b/ccan/net/_info
@@ -2,9 +2,11 @@
 #include "config.h"
 
 /**
- * net - simple IPv4/IPv6 client library
+ * net - simple IPv4/IPv6 socket library
  *
- * This code makes it simple to support IPv4 and IPv6 without speed penalty.
+ * This code makes it simple to support IPv4 and IPv6 without speed penalty
+ * in clients by using non-blocking simultaneous connect, and using
+ * a convenience function to create both IPv4 and IPv6 sockets for servers.
  *
  * License: MIT
  *
@@ -14,6 +16,7 @@
  *	#include <ccan/net/net.h>
  *	#include <sys/types.h>
  *	#include <sys/socket.h>
+ *	#include <netinet/in.h>
  *	#include <stdio.h>
  *	#include <err.h>
  *
@@ -22,8 +25,12 @@
  *		struct addrinfo *addr;
  *		const char *dest, *port;
  *		int fd;
- *		struct sockaddr saddr;
- *		socklen_t slen = sizeof(saddr);
+ *		union {
+ *			struct sockaddr s;
+ *			struct sockaddr_in v4;
+ *			struct sockaddr_in6 v6;
+ *		} u;
+ *		socklen_t slen = sizeof(u);
  *	
  *		if (argc == 2) {
  *			dest = argv[1];
@@ -42,10 +49,10 @@
  *		if (fd < 0)
  *			err(1, "Failed to connect to %s", dest);
  *	
- *		if (getsockname(fd, &saddr, &slen) == 0)
+ *		if (getsockname(fd, &u.s, &slen) == 0)
  *			printf("Connected via %s\n",
- *			       saddr.sa_family == AF_INET6 ? "IPv6"
- *			       : saddr.sa_family == AF_INET ? "IPv4"
+ *			       u.s.sa_family == AF_INET6 ? "IPv6"
+ *			       : u.s.sa_family == AF_INET ? "IPv4"
  *			       : "UNKNOWN??");
  *		else
  *			err(1, "Failed to get socket type for connection");