From 156669c28bc62bfddbd5625c4bb4c1f8da94802b Mon Sep 17 00:00:00 2001
From: Sam Roberts <vieuxtech@gmail.com>
Date: Thu, 10 May 2012 14:14:22 -0700
Subject: socket.connect now implemented in the C core

This avoid socket.lua duplicating the iteration over the results
of getaddrinfo(). Some problems with the C implementation not
initializing sockets or the luasocket family have also been fixed,
and error reporting made more robust.
---
 doc/reference.html |  2 ++
 doc/socket.html    | 11 ++++++++---
 2 files changed, 10 insertions(+), 3 deletions(-)

(limited to 'doc')

diff --git a/doc/reference.html b/doc/reference.html
index f069d47..e9bb5eb 100644
--- a/doc/reference.html
+++ b/doc/reference.html
@@ -145,6 +145,8 @@ Support, Manual">
 <blockquote>
 <a href="socket.html#bind">bind</a>,
 <a href="socket.html#connect">connect</a>,
+<a href="socket.html#connect">connect4</a>,
+<a href="socket.html#connect">connect6</a>,
 <a href="socket.html#debug">_DEBUG</a>,
 <a href="dns.html#dns">dns</a>,
 <a href="socket.html#gettime">gettime</a>,
diff --git a/doc/socket.html b/doc/socket.html
index dcf8b61..b9303cb 100644
--- a/doc/socket.html
+++ b/doc/socket.html
@@ -73,14 +73,19 @@ set to <tt><b>true</b></tt>.
 <!-- connect ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
 
 <p class=name id=connect> 
-socket.<b>connect(</b>address, port [, locaddr, locport]<b>)</b>
+socket.<b>connect[46](</b>address, port [, locaddr] [, locport] [, family]<b>)</b>
 </p>
 
 <p class=description>
 This function is a shortcut that creates and returns a TCP client object
-connected to a remote <tt>host</tt> at a given <tt>port</tt>. Optionally,
+connected to a remote <tt>address</tt> at a given <tt>port</tt>. Optionally,
 the user can also specify the local address and port to bind
-(<tt>locaddr</tt> and <tt>locport</tt>).
+(<tt>locaddr</tt> and <tt>locport</tt>), or restrict the socket family
+to "<tt>inet</tt>" or "<tt>inet6</tt>".
+Without specifying <tt>family</tt> to <tt>connect</tt>, whether a tcp or tcp6
+connection is created depends on your system configuration. Two variations
+of connect are defined as simple helper functions that restrict the
+<tt>family</tt>, <tt>socket.connect4</tt> and <tt>socket.connect6</tt>.
 </p>
 
 <!-- debug ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
-- 
cgit v1.2.3-55-g6feb