doc: fix net.Server.listen bind behavior
authorAndres Suarez <zertosh@gmail.com>
Mon, 19 Jan 2015 02:24:11 +0000 (21:24 -0500)
committerRod Vagg <rod@vagg.org>
Tue, 27 Jan 2015 05:31:15 +0000 (16:31 +1100)
PR-URL: https://github.com/iojs/io.js/pull/503
Reviewed-By: Rod Vagg <rod@vagg.org>
doc/api/http.markdown
doc/api/net.markdown
doc/api/tls.markdown

index df76a25..ec1fdfe 100644 (file)
@@ -162,9 +162,10 @@ If a client connection emits an 'error' event, it will be forwarded here.
 
 ### server.listen(port[, hostname][, backlog][, callback])
 
-Begin accepting connections on the specified port and hostname.  If the
-hostname is omitted, the server will accept connections directed to any
-IPv4 address (`INADDR_ANY`).
+Begin accepting connections on the specified `port` and `hostname`. If the
+`hostname` is omitted, the server will accept connections on any IPv6 address
+(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise. A
+port value of zero will assign a random port.
 
 To listen to a unix socket, supply a filename instead of port and hostname.
 
index f1fdf99..ff204a2 100644 (file)
@@ -137,11 +137,12 @@ A factory method which returns a new ['net.Socket'](#net_class_net_socket).
 
 This class is used to create a TCP or local server.
 
-### server.listen(port[, host][, backlog][, callback])
+### server.listen(port[, hostname][, backlog][, callback])
 
-Begin accepting connections on the specified `port` and `host`.  If the
-`host` is omitted, the server will accept connections directed to any
-IPv4 address (`INADDR_ANY`). A port value of zero will assign a random port.
+Begin accepting connections on the specified `port` and `hostname`. If the
+`hostname` is omitted, the server will accept connections on any IPv6 address
+(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise. A
+port value of zero will assign a random port.
 
 Backlog is the maximum length of the queue of pending connections.
 The actual length will be determined by your OS through sysctl settings such as
index 11cea44..1587622 100644 (file)
@@ -586,11 +586,12 @@ NOTE: you may want to use some npm module like [asn1.js] to parse the
 certificates.
 
 
-### server.listen(port[, host][, callback])
+### server.listen(port[, hostname][, callback])
 
-Begin accepting connections on the specified `port` and `host`.  If the
-`host` is omitted, the server will accept connections directed to any
-IPv4 address (`INADDR_ANY`).
+Begin accepting connections on the specified `port` and `hostname`. If the
+`hostname` is omitted, the server will accept connections on any IPv6 address
+(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise. A
+port value of zero will assign a random port.
 
 This function is asynchronous. The last parameter `callback` will be called
 when the server has been bound.