summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-11-30 19:18:01 -0800
committerAnna Henningsen <anna@addaleax.net>2019-12-03 23:23:08 +0100
commitb52deecce583be22dcd66a0208d452261c1a175a (patch)
tree14c38dd3fa3af0f21e4eaac153cf42e554d670d8 /doc
parent660c4337baf9ad0d5ecb5b4b76d17a34d326065f (diff)
downloadandroid-node-v8-b52deecce583be22dcd66a0208d452261c1a175a.tar.gz
android-node-v8-b52deecce583be22dcd66a0208d452261c1a175a.tar.bz2
android-node-v8-b52deecce583be22dcd66a0208d452261c1a175a.zip
doc: clarify text about using 'session' event for compatibility
PR-URL: https://github.com/nodejs/node/pull/30746 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/tls.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md
index 3fd8e8cb49..8fa601096b 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -726,14 +726,14 @@ On the client, the `session` can be provided to the `session` option of
See [Session Resumption][] for more information.
-Note: For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
-the handshake is complete. For TLSv1.3, only ticket based resumption is allowed
+For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
+the handshake is complete. For TLSv1.3, only ticket-based resumption is allowed
by the protocol, multiple tickets are sent, and the tickets aren't sent until
-later, after the handshake completes, so it is necessary to wait for the
-`'session'` event to get a resumable session. Applications are
-recommended to use the `'session'` event instead of `getSession()` to ensure
-they will work for all TLS protocol versions. Applications that only expect to
-get or use 1 session should listen for this event only once:
+after the handshake completes. So it is necessary to wait for the
+`'session'` event to get a resumable session. Applications
+should use the `'session'` event instead of `getSession()` to ensure
+they will work for all TLS versions. Applications that only expect to
+get or use one session should listen for this event only once:
```js
tlsSocket.once('session', (session) => {