Document HttpResponseMessage.Dispose will terminate response and notify the server

[JamesNK]

HttpResponseMessage.Dispose() docs should mention that it will terminate a response early and send a notification to the server (e.g. HTTP/2 RST_STREAM).

https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage.dispose?view=net-5.0

[ghost]

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

---

HttpResponseMessage.Dispose() docs should mention that it will terminate a response early and send a notification to the server (e.g. HTTP/2 RST_STREAM).

https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage.dispose?view=net-5.0

Author:	JamesNK
Assignees:	-
Labels:	area-System.Net.Http, documentation
Milestone:	-

[geoffkizer]

I suppose we could do this, but it's sort of a low-level detail that is invisible to most people. And the behavior is version dependent.

Why does it matter? If a user disposes the HttpResponseMessage then they have indicated they don't care about the response anymore. Whether that actually cancels it on the wire or not seems like an implementation detail.

[karelz]

Triage: @JamesNK do you want to put up PR with the language change from email exchange?

[karelz]

Found it: "Disposing a response that is in-progress can signal to the server that the response is no longer needed. This signal is implementation/protocol dependent"