Browse Source

doc: fix net.Server.listen bind behavior

PR-URL: https://github.com/iojs/io.js/pull/503
Reviewed-By: Rod Vagg <rod@vagg.org>
v1.8.0-commit
Andres Suarez 10 years ago
committed by Rod Vagg
parent
commit
5c7ab96b90
  1. 7
      doc/api/http.markdown
  2. 9
      doc/api/net.markdown
  3. 9
      doc/api/tls.markdown

7
doc/api/http.markdown

@ -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.

9
doc/api/net.markdown

@ -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

9
doc/api/tls.markdown

@ -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.

Loading…
Cancel
Save