Skip to content

Commit 16a2201

Browse files
authored
WinHttpHandler clean up and removal note (#4692)
* Contributes to dotnet/docs#19727
1 parent d231b5d commit 16a2201

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

xml/System.Net.Http/WinHttpHandler.xml

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,24 @@
2323
<Interfaces />
2424
<Docs>
2525
<summary>
26-
<see cref="T:System.Net.Http.WinHttpHandler" /> is a specialty message handler based on the WinHTTP interface of Windows and is intended for use in server environments. This class is also available for use in Desktop apps by installing it as a NuGet package. For more information about installing this class for use in Desktop apps, see [System.Net.Http.WinHttpHandler](https://go.microsoft.com/fwlink/?LinkId=620067).</summary>
26+
Handles messages based on the WinHTTP interface of Windows. This class is intended for use in server environments.</summary>
2727
<remarks>
2828
<format type="text/markdown"><![CDATA[
2929
30-
## Remarks
30+
## Remarks
31+
3132
<xref:System.Net.Http.WinHttpHandler> is similar to other existing classes such as <xref:System.Net.Http.HttpClientHandler>. <xref:System.Net.Http.WinHttpHandler> provides a handler underneath an <xref:System.Net.Http.HttpClient> instance and is used to send HTTP requests out to a server and receive server responses.
3233
33-
<xref:System.Net.Http.WinHttpHandler> is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. <xref:System.Net.Http.WinHttpHandler> also provides developers with more granular control over the application's HTTP communication than the <xref:System.Net.Http.HttpClientHandler> class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts and server SSL certificate validation).
34-
35-
<xref:System.Net.Http.WinHttpHandler> is not intended to be a replacement for <xref:System.Net.Http.HttpClientHandler>, it is a more advanced version provided for scenarios where <xref:System.Net.Http.HttpClientHandler> is insufficient for developers. <xref:System.Net.Http.WinHttpHandler> is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems.
34+
<xref:System.Net.Http.WinHttpHandler> is designed to be used primarily in server environments by ASP.NET Core and other .NET applications that communicate with HTTP servers. <xref:System.Net.Http.WinHttpHandler> also provides developers with more granular control over the application's HTTP communication than the <xref:System.Net.Http.HttpClientHandler> class. This allows developers to implement more advanced HTTP scenarios or modify system defaults (for example, proxy settings, timeouts, and server SSL certificate validation).
3635
37-
When using a chain of multiple handlers, <xref:System.Net.Http.WinHttpHandler> should be at the bottom of the chain.
36+
<xref:System.Net.Http.WinHttpHandler> is not intended to be a replacement for <xref:System.Net.Http.HttpClientHandler>. Instead, it's a more advanced version that's provided for scenarios where <xref:System.Net.Http.HttpClientHandler> is insufficient. <xref:System.Net.Http.WinHttpHandler> is implemented as a thin wrapper on the WinHTTP interface of Windows and is only supported on Windows systems.
3837
38+
When using a chain of multiple handlers, <xref:System.Net.Http.WinHttpHandler> should be at the bottom of the chain.
39+
40+
This class is also available for use in Desktop apps by installing it as a NuGet package. For more information, see [System.Net.Http.WinHttpHandler NuGet package](https://www.nuget.org/packages/System.Net.Http.WinHttpHandler/).
41+
42+
Starting in .NET 5.0, <xref:System.Net.Http.WinHttpHandler> is no longer included in the *System.Net.Http.dll* assembly as part of the .NET runtime. For more information, see [WinHttpHandler removed from .NET runtime](/dotnet/core/compatibility/3.1-5.0#winhttphandler-removed-from-net-runtime).
43+
3944
]]></format>
4045
</remarks>
4146
</Docs>
@@ -95,7 +100,7 @@
95100
<format type="text/markdown"><![CDATA[
96101
97102
## Remarks
98-
The default value for this property is GZip &#124; Deflate.
103+
The default value for this property is `GZip | Deflate`.
99104
100105
]]></format>
101106
</remarks>
@@ -126,12 +131,13 @@
126131
</ReturnValue>
127132
<Docs>
128133
<summary>Gets or sets a value that indicates whether the handler should follow HTTP redirection responses.</summary>
129-
<value>To be added.</value>
134+
<value><see langword="true" /> to follow HTTP redirection responses; otherwise, <see langword="false" />. The default is <see langword="true" />.</value>
130135
<remarks>
131136
<format type="text/markdown"><![CDATA[
132137
133-
## Remarks
134-
The default value for this property is true. In this configuration, all HTTP redirect responses from the server will be followed automatically except if they are redirecting from an HTTPS endpoint to an HTTP endpoint.
138+
## Remarks
139+
140+
When this property is set to `true`, all HTTP redirect responses from the server will be followed automatically except if they are redirecting from an HTTPS endpoint to an HTTP endpoint.
135141
136142
]]></format>
137143
</remarks>
@@ -162,15 +168,8 @@
162168
</ReturnValue>
163169
<Docs>
164170
<summary>Gets or sets a value that indicates whether to check the revocation list of certificates during SSL certificate validation.</summary>
165-
<value>To be added.</value>
166-
<remarks>
167-
<format type="text/markdown"><![CDATA[
168-
169-
## Remarks
170-
The default value for this property is false.
171-
172-
]]></format>
173-
</remarks>
171+
<value><see langword="true" /> to check the revocation list of certificates during SSL certificate validation; otherwise, <see langword="false" />. The default is <see langword="false" />.</value>
172+
<remarks>To be added.</remarks>
174173
</Docs>
175174
</Member>
176175
<Member MemberName="ClientCertificateOption">
@@ -234,7 +233,7 @@
234233
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2Collection</ReturnType>
235234
</ReturnValue>
236235
<Docs>
237-
<summary>Gets or sets a collection of client authentication SSL certificates that are used for client authentication by the Handler if the <see cref="P:System.Net.Http.WinHttpHandler.ClientCertificateOption" /> property is set to Manual.</summary>
236+
<summary>Gets a collection of client authentication SSL certificates that are used for client authentication by the handler if the <see cref="P:System.Net.Http.WinHttpHandler.ClientCertificateOption" /> property is set to <see langword="Manual" />.</summary>
238237
<value>To be added.</value>
239238
<remarks>
240239
<format type="text/markdown"><![CDATA[
@@ -573,7 +572,7 @@
573572
<format type="text/markdown"><![CDATA[
574573
575574
## Remarks
576-
The default value for this property is false.
575+
The default value for this property is `false`.
577576
578577
]]></format>
579578
</remarks>
@@ -639,7 +638,7 @@
639638
<format type="text/markdown"><![CDATA[
640639
641640
## Remarks
642-
The default value for this property is null.
641+
The default value for this property is `null`.
643642
644643
]]></format>
645644
</remarks>
@@ -814,12 +813,12 @@
814813
</ReturnValue>
815814
<Docs>
816815
<summary>Gets or sets a callback method to validate the server certificate. This callback is part of the SSL handshake.</summary>
817-
<value>The callback should return true if the server certificate is considered valid and the request should be sent. Otherwise, return false.</value>
816+
<value>The callback should return <see langword="true" /> if the server certificate is considered valid and the request should be sent. Otherwise, return <see langword="false" />.</value>
818817
<remarks>
819818
<format type="text/markdown"><![CDATA[
820819
821820
## Remarks
822-
The default value is null. If this property is null, the server certificate will be validated using standard well-known certificate authorities.
821+
The default value is `null`. If this property is `null`, the server certificate is validated using standard well-known certificate authorities.
823822
824823
]]></format>
825824
</remarks>
@@ -855,7 +854,7 @@
855854
<format type="text/markdown"><![CDATA[
856855
857856
## Remarks
858-
The default value for this property is null.
857+
The default value for this property is `null`.
859858
860859
]]></format>
861860
</remarks>
@@ -891,7 +890,7 @@
891890
<format type="text/markdown"><![CDATA[
892891
893892
## Remarks
894-
The default value is SslProtocols.Tls &#124; SslProtocols.Tls11 &#124; SslProtocols.Tls12.
893+
The default value is `SslProtocols.Tls | SslProtocols.Tls11 | SslProtocols.Tls12`.
895894
896895
]]></format>
897896
</remarks>

0 commit comments

Comments
 (0)