Skip to content

doc: document the connection event for HTTP2 & TLS servers

Rodrigo Muino Tomonari requested to merge github/fork/pimterry/connection-event-docs into master

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

Merge request reports