Skip to content

Details about AutomaticDecompression #8472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 7, 2022
Merged

Details about AutomaticDecompression #8472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6d36b2
Details about AutomaticDecompression
ManickaP Oct 6, 2022
64b1e4b
Update xml/System.Net.Http/HttpClientHandler.xml
ManickaP Oct 7, 2022
5e11d91
Update xml/System.Net.Http/SocketsHttpHandler.xml
ManickaP Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions xml/System.Net.Http/HttpClientHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,12 @@ These configuration options are not available starting with .NET 5.
<format type="text/markdown"><![CDATA[

## Remarks
Automatic decompression works only on the top most compression. So if the content is compressed multiple times, only the last compression will be decompressed.
For example, for a reponse with `Content-Encoding: gzip, br` header, the content will only be decompressed using Brotli, leaving the still gzipped content in the <xref:System.Net.Http.HttpResponseMessage.Content>.
Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reponse

response

Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For example, for a reponse with Content-Encoding: gzip, br header

"For example, for a response with a Content-Encoding: gzip, br header that contains content first compressed with gzip and then that compressed content Brotli compressed,"


Setting automatic decompression to anything else than <xref:System.Net.DecompressionMethods.None> will cause adding `Accept-Encoding` header with the set values into every outgoing <xref:System.Net.Http.HttpRequestMessage>.
Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to anything else than

"to anything other than"

Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will cause adding Accept-Encoding header with

"will result in adding an Accept-Encoding header with"



For the .NET Framework 4.x `System.Net.Http` binary in the Global Assembly Cache (GAC), the default value is <xref:System.Net.DecompressionMethods.None>.

When the [`System.Net.Http` NuGet package](https://www.nuget.org/packages/System.Net.Http/) v4.1.0 to v4.3.2 is used, the default is <xref:System.Net.DecompressionMethods.GZip> and <xref:System.Net.DecompressionMethods.Deflate>.
Expand Down
12 changes: 11 additions & 1 deletion xml/System.Net.Http/SocketsHttpHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,17 @@ These configuration options are not available starting with .NET 5.
<Docs>
<summary>Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response.</summary>
<value>The type of decompression method used by the handler for automatic decompression of the HTTP content response.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Copy link
Member

@stephentoub stephentoub Oct 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comments as above.

Automatic decompression works only on the top most compression. So if the content is compressed multiple times, only the last compression will be decompressed.
For example, for a reponse with `Content-Encoding: gzip, br` header, the content will only be decompressed using Brotli, leaving the still gzipped content in the <xref:System.Net.Http.HttpResponseMessage.Content>.

Setting automatic decompression to anything else than <xref:System.Net.DecompressionMethods.None> will cause adding `Accept-Encoding` header with the set values into every outgoing <xref:System.Net.Http.HttpRequestMessage>.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ConnectCallback">
Expand Down