Skip to content

Update static usage remarks #7833

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

Closed
wants to merge 2 commits into from
Closed

Update static usage remarks #7833

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c7feed
Update static usage remarks
rasitha1 Mar 16, 2022
0ca56b0
Merge pull request #1 from rasitha1/update-static-use-remarks
rasitha1 Mar 16, 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
13 changes: 11 additions & 2 deletions xml/System.Net.Http/HttpClient.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,11 @@

10. <xref:System.Net.Http.HttpClient.PatchAsync%2A>

<xref:System.Net.Http.HttpClient> is intended to be instantiated once and re-used throughout the life of an application. Instantiating an HttpClient class for every request will exhaust the number of sockets available under heavy loads. This will result in SocketException errors. Below is an example using HttpClient correctly.
<xref:System.Net.Http.HttpClient> is intended to be instantiated once and re-used throughout the life of an application. Instantiating an HttpClient class for every request will exhaust the number of sockets available under heavy loads. This will result in SocketException errors.

However, long running applications using <xref:System.Net.Http.HttpClient> as a singleton may run into problems with not picking up DNS changes. A better approach for such cases is to utilize the `HttpClientFactory` introduced in .NET Core 2.1, which handles the lifetime of the underlying <xref:System.Net.Http.HttpMessageHandler>. It will also allow an application to use DI and inject a <xref:System.Net.Http.HttpClient>.

Below is an example using HttpClient for a short-lived application that does not have DNS change concerns. For examples on how to use `HttpClientFactory` and DI, [refer to this guide on HttpClientFactory](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#multiple-ways-to-use-ihttpclientfactory).

```csharp
public class GoodController : ApiController
Expand Down Expand Up @@ -157,7 +161,12 @@ Certain aspects of <xref:System.Net.Http.HttpClient>'s behavior are customizable
<format type="text/markdown"><![CDATA[

## Remarks
<xref:System.Net.Http.HttpClient> is intended to be instantiated once and re-used throughout the life of an application. Instantiating an HttpClient class for every request will exhaust the number of sockets available under heavy loads. This will result in SocketException errors. Below is an example using HttpClient correctly.
<xref:System.Net.Http.HttpClient> is intended to be instantiated once and re-used throughout the life of an application. Instantiating an HttpClient class for every request will exhaust the number of sockets available under heavy loads. This will result in SocketException errors.

However, long running applications using <xref:System.Net.Http.HttpClient> as a singleton may run into problems with not picking up DNS changes. A better approach for such cases is to utilize the `HttpClientFactory` introduced in .NET Core 2.1, which handles the lifetime of the underlying <xref:System.Net.Http.HttpMessageHandler>. It will also allow an application to use DI and inject a <xref:System.Net.Http.HttpClient>.

Below is an example using HttpClient for a short-lived application that does not have DNS change concerns. For examples on how to use `HttpClientFactory` and DI, [refer to this guide on HttpClientFactory](https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#multiple-ways-to-use-ihttpclientfactory).


```csharp
public class GoodController : ApiController
Expand Down