Skip to content

Commit

Permalink
doc: clarify default TLS handshake timeout
Browse files Browse the repository at this point in the history
Because the `handshakeTimeout` is in milliseconds, use that unit of
measurement to express the default value.

PR-URL: #19290
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and MylesBorins committed Mar 20, 2018
1 parent a9bd8bf commit 5da3ee7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1126,9 +1126,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`.
Expand Down

0 comments on commit 5da3ee7

Please sign in to comment.