This repository has been archived by the owner on Apr 22, 2023. It is now read-only.
doc: Update doc for http.IncomingMessage.socket #5502
Closed
+5
−3
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.
For HTTPS servers, the socket property of the IncomingMessage is a
tls.CleartextStream rather than a net.Socket. Update the documentation
to reflect this and note that the underlying socket can be accessed
through the socket property of the tls.CleartextStream.
Also update the documentation for getting the client authentication
details. verifyPeer was removed in df46c8e 2.5 years ago and
request.connection is a now-undocumented alias for request.socket.
Update these to the current names.
Reviewer Note: The socket property of
tls.CleartextStream
is not currently documented elsewhere (that I am aware of). If this is not intended to be part of the public API, is there an alternate way to get commonly used socket information (e.g. local and remote address and port) for HTTPS requests? If so, I can update and re-send the pull request using that method.Thanks for considering,
Kevin