doc: document the connection event for HTTP2 & TLS servers #34531
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jul 27, 2020
Closed
lpinca
approved these changes
Aug 1, 2020
This was referenced Aug 3, 2020
|
@nodejs/build can you check this? |
I've added a Rerun CI-Lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4195/ |
|
Landed in e5dacc2 |
mcollina
pushed a commit
that referenced
this pull request
Aug 3, 2020
PR-URL: #34531 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This was referenced Aug 4, 2020
codebytere
pushed a commit
that referenced
this pull request
Aug 6, 2020
PR-URL: #34531 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This was referenced Aug 7, 2020
This was referenced Aug 9, 2020
Merged
codebytere
pushed a commit
that referenced
this pull request
Aug 11, 2020
PR-URL: #34531 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Sep 22, 2020
PR-URL: #34531 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Sep 22, 2020
PR-URL: #34531 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As discussed in #34296, the documentation isn't totally clear on where 'connection' events can be manually emitted, or that doing so is an officially supported use case for those events.
This PR is a quick first step to improve that - taking the text from the same event in the HTTP module (where this is already documented) and including it in the docs for TLS servers, HTTP2 servers & HTTP2 secure servers.
I've simplified the text from the HTTP event to remove details that I'm not 100% sure are true for non-HTTP servers: setTimeout handling, and the specific class of sockets that could ever possibly be emitted here. I don't think either is required for this to be useful, but happy to add those details here too if somebody can confirm they're equally relevant & true.
Checklist