From a152458e6edca126f3dd3bc8d8ddbbed9d629d51 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 30 Nov 2019 19:18:01 -0800 Subject: [PATCH] doc: clarify text about using 'session' event for compatibility PR-URL: https://github.com/nodejs/node/pull/30746 Reviewed-By: Sam Roberts Reviewed-By: Anna Henningsen --- doc/api/tls.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index eea25ddb260b61..f3ba8c16288e45 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) => {