0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 23:16:30 +01:00

doc: clarify default TLS handshake timeout

Because the `handshakeTimeout` is in milliseconds, use that unit of
measurement to express the default value.

PR-URL: https://github.com/nodejs/node/pull/19290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2018-03-11 17:30:56 -07:00
parent 4ae320f2b3
commit 14809aaa98

View File

@ -1127,9 +1127,9 @@ changes:
* `clientCertEngine` {string} Optional name of an OpenSSL engine which can
provide the client certificate.
* `handshakeTimeout` {number} Abort the connection if the SSL/TLS handshake
does not finish in the specified number of milliseconds. Defaults to `120`
seconds. A `'tlsClientError'` is emitted on the `tls.Server` object whenever
a handshake times out.
does not finish in the specified number of milliseconds. Defaults to
`120000` (120 seconds). A `'tlsClientError'` is emitted on the `tls.Server`
object whenever a handshake times out.
* `requestCert` {boolean} If `true` the server will request a certificate from
clients that connect and attempt to verify that certificate. Defaults to
`false`.