doc: clarify text about using 'session' event for compatibility · nodejs/node@a152458 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 756
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit a152458

Browse filesBrowse the repository at this point in the historyBrowse files

Trott

authored and

BethGriggs

committed

doc: clarify text about using 'session' event for compatibility

PR-URL: #30746 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>

1 parent b233c36 commit a152458
Copy full SHA for a152458

1 file changed

+7-7Lines changed: 7 additions & 7 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • tls.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/tls.md‎

Copy file name to clipboardExpand all lines: doc/api/tls.md

+7-7Lines changed: 7 additions & 7 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -726,14 +726,14 @@ On the client, the `session` can be provided to the `session` option of
726	726
727	727	See [Session Resumption][] for more information.
728	728
729		- Note: For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
730		- the handshake is complete. For TLSv1.3, only ticket based resumption is allowed
	729	+ For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
	730	+ the handshake is complete. For TLSv1.3, only ticket-based resumption is allowed
731	731	by the protocol, multiple tickets are sent, and the tickets aren't sent until
732		- later, after the handshake completes, so it is necessary to wait for the
733		- `'session'` event to get a resumable session. Applications are
734		- recommended to use the `'session'` event instead of `getSession()` to ensure
735		- they will work for all TLS protocol versions. Applications that only expect to
736		- get or use 1 session should listen for this event only once:
	732	+ after the handshake completes. So it is necessary to wait for the
	733	+ `'session'` event to get a resumable session. Applications
	734	+ should use the `'session'` event instead of `getSession()` to ensure
	735	+ they will work for all TLS versions. Applications that only expect to
	736	+ get or use one session should listen for this event only once:
737	737
738	738	```js
739	739	tlsSocket.once('session', (session) => {

0 commit comments

Comments

0 (0)