diff options
| author | Martin Michaelis <code@mgjm.de> | 2017-10-06 11:50:47 -0700 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2017-10-19 02:26:01 -0200 |
| commit | 278f65351231f9fa034220780fba8aae940c1b9a (patch) | |
| tree | 21843f8ed79456d6e6cb1d55d469487c03d2d181 /doc/api/tls.md | |
| parent | dc086834b14647acacfd6d1e9a20bf83df34644a (diff) | |
| download | android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.tar.gz android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.tar.bz2 android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.zip | |
doc: fix inconsistent server.listen documentation
The `net`, `tls`, `http` and `https` module have the same
`server.listen()` method, but have a different documenation.
Changed to a consistent link to the documentation of the `net` module.
PR-URL: https://github.com/nodejs/node/pull/16020
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 24 |
1 files changed, 4 insertions, 20 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md index f001f4f265..26d7e157aa 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -408,27 +408,10 @@ added: v3.0.0 Returns a `Buffer` instance holding the keys currently used for encryption/decryption of the [TLS Session Tickets][] -### server.listen(port[, hostname][, callback]) -<!-- YAML -added: v0.3.2 ---> - -* `port` {number} The TCP/IP port on which to begin listening for connections. - A value of `0` (zero) will assign a random port. -* `hostname` {string} The hostname, IPv4, or IPv6 address on which to begin - listening for connections. If `undefined`, the server will accept connections - on any IPv6 address (`::`) when IPv6 is available, or any IPv4 address - (`0.0.0.0`) otherwise. -* `callback` {Function} A callback function to be invoked when the server has - begun listening on the `port` and `hostname`. - -The `server.listen()` methods instructs the server to begin accepting -connections on the specified `port` and `hostname`. - -This function operates asynchronously. If the `callback` is given, it will be -called when the server has started listening. +### server.listen() -See [`net.Server`][] for more information. +Starts the server listening for encrypted connections. +This method is identical to [`server.listen()`][] from [`net.Server`][]. ### server.setTicketKeys(keys) <!-- YAML @@ -1292,6 +1275,7 @@ where `secure_socket` has the same API as `pair.cleartext`. [`net.Server`]: net.html#net_class_net_server [`net.Socket`]: net.html#net_class_net_socket [`server.getConnections()`]: net.html#net_server_getconnections_callback +[`server.listen()`]: net.html#net_server_listen [`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve [`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed [`tls.TLSSocket`]: #tls_class_tls_tlssocket |