From 380dc75b39bf77f0e7f7bd05a8b059b4e10a8b36 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 27 May 2020 11:27:07 +0200 Subject: [PATCH 01/10] Add ctor doc --- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 72e07271b50..c629fbd271d 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -70,7 +70,7 @@ If this change is undesirable, you can configure your application to use the old - To be added. + Creates an instance of a class. To be added. From e0f84335b49000b7b002cfc974a095efa59d08d5 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 27 May 2020 12:59:24 +0200 Subject: [PATCH 02/10] AllowAutoRedirect doc --- xml/System.Net.Http/SocketsHttpHandler.xml | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index c629fbd271d..657b9b08028 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -92,9 +92,24 @@ If this change is undesirable, you can configure your application to use the old System.Boolean - To be added. - To be added. - To be added. + Gets or sets a value that indicates whether the handler should follow redirection responses. + + if the handler should follow redirection responses; otherwise . The default value is . + + + to `true` if you want the handler to automatically follow HTTP redirection headers to the new location of the resource. The maximum number of redirections to follow is set by the property. + + If is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application. + + The Authorization header is cleared on auto-redirects and the handler automatically tries to re-authenticate to the redirected location. In practice, this means that an application can't put custom authentication information into the Authorization header if it is possible to encounter redirection. Instead, the application must implement and register a custom authentication module. + +> [!NOTE] +> Handler never follow a redirection from HTTPS to HTTP even if is set to `true`. + + ]]> From 2e52825c8610cb92f01261570a321a01d69657a2 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 27 May 2020 13:52:16 +0200 Subject: [PATCH 03/10] Connect timeout doc --- xml/System.Net.Http/SocketsHttpHandler.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 657b9b08028..866b91af322 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -153,8 +153,8 @@ If this change is undesirable, you can configure your application to use the old System.TimeSpan - To be added. - To be added. + Gets or sets the timespan to wait before the connection establishing times out. + The timespan to wait before the connection establishing times out. The default value is . To be added. From db7919fae9cacc09ea25ab50756055f7d10f82fd Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 27 May 2020 13:56:48 +0200 Subject: [PATCH 04/10] Credentials doc --- xml/System.Net.Http/SocketsHttpHandler.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 866b91af322..e7075589459 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -199,8 +199,8 @@ If this change is undesirable, you can configure your application to use the old System.Net.ICredentials - To be added. - To be added. + Gets or sets authentication information used by this handler. + The authentication credentials associated with the handler. The default is . To be added. From 4d5f05fdf57c1c31a73b6a1954cac8e54abf58b5 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 27 May 2020 15:08:18 +0200 Subject: [PATCH 05/10] SocketsHttpHandler.Expect100ContinueTimeout doc --- xml/System.Net.Http/SocketsHttpHandler.xml | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index e7075589459..f630bff1d35 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -277,9 +277,15 @@ The default proxy is used only when System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the time-out value for server HTTP 100 Continue response. + The timespan to wait for the HTTP 100 Continue. The default value is 1 second. + + define the timeout for the `100 Continue` server response. + + ]]> From a8a8fa5a377a7272a7b90548717f68d0a316d522 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 3 Jun 2020 12:35:20 +0200 Subject: [PATCH 06/10] Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Maira Wenzel --- xml/System.Net.Http/SocketsHttpHandler.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index e7075589459..2049921b212 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -110,6 +110,7 @@ If this change is undesirable, you can configure your application to use the old > Handler never follow a redirection from HTTPS to HTTP even if is set to `true`. ]]> + From 23cda33b3ccc65b99ec209e74c8b743689494643 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 10 Jun 2020 14:10:47 +0200 Subject: [PATCH 07/10] Apply suggestions from code review Co-authored-by: Karel Zikmund Co-authored-by: Maira Wenzel --- xml/System.Net.Http/SocketsHttpHandler.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 001e9bd7c4b..dacd2dbf064 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -102,12 +102,12 @@ If this change is undesirable, you can configure your application to use the old ## Remarks Set to `true` if you want the handler to automatically follow HTTP redirection headers to the new location of the resource. The maximum number of redirections to follow is set by the property. - If is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application. + If is set to `false`, all HTTP responses with an HTTP status code from 300 to 399 are returned to the application. The Authorization header is cleared on auto-redirects and the handler automatically tries to re-authenticate to the redirected location. In practice, this means that an application can't put custom authentication information into the Authorization header if it is possible to encounter redirection. Instead, the application must implement and register a custom authentication module. > [!NOTE] -> Handler never follow a redirection from HTTPS to HTTP even if is set to `true`. +> The handler never follows a redirection from HTTPS to HTTP even if is set to `true`. ]]> @@ -155,7 +155,7 @@ If this change is undesirable, you can configure your application to use the old Gets or sets the timespan to wait before the connection establishing times out. - The timespan to wait before the connection establishing times out. The default value is . + The timespan to wait before the connection establishing times out. The default value is . To be added. @@ -201,7 +201,7 @@ If this change is undesirable, you can configure your application to use the old Gets or sets authentication information used by this handler. - The authentication credentials associated with the handler. The default is . + The authentication credentials associated with the handler. The default value is . To be added. From e6faf182a0987daf13aa1efbb868f67dc3b89f23 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Wed, 10 Jun 2020 15:50:30 +0200 Subject: [PATCH 08/10] Documentation --- xml/System.Net.Http/SocketsHttpHandler.xml | 35 +++++++++++++++------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 001e9bd7c4b..46044268750 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -437,9 +437,18 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets how long a connection can be the pool to be considered reusable. + The maximum time for a connection to be in the pool. The default value for this property is . + . + + ]]> + + The value specified is less than or is equal to . @@ -530,9 +539,15 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.TimeSpan - To be added. - To be added. - To be added. + Gets or sets the timespan to wait for data to be drained from responses. + The timespan to wait for data to be drained from responses. + + + @@ -605,8 +620,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether the handler should use cookies. + A value that indicates whether the handler should use cookies. To be added. @@ -628,8 +643,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r System.Boolean - To be added. - To be added. + Gets or sets a value that indicates whether the handler should use a proxy. + A value that indicates whether the handler should use a proxy. To be added. From 8053a82b4a54b7f510802d53a0e01cca14acd99d Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Fri, 26 Jun 2020 14:26:23 +0200 Subject: [PATCH 09/10] Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Maira Wenzel --- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 274559843db..1260de0afd1 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -154,7 +154,7 @@ If this change is undesirable, you can configure your application to use the old System.TimeSpan - Gets or sets the timespan to wait before the connection establishing times out. + Gets or sets the timespan to wait before the connection establishing times out. The timespan to wait before the connection establishing times out. The default value is . To be added. From 63fe72acbd6ba5d90bdd9b94529c6d37fa7d8866 Mon Sep 17 00:00:00 2001 From: Jan Jahoda Date: Fri, 26 Jun 2020 14:27:45 +0200 Subject: [PATCH 10/10] RP comments --- xml/System.Net.Http/SocketsHttpHandler.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Net.Http/SocketsHttpHandler.xml b/xml/System.Net.Http/SocketsHttpHandler.xml index 1260de0afd1..9a2aaa89235 100644 --- a/xml/System.Net.Http/SocketsHttpHandler.xml +++ b/xml/System.Net.Http/SocketsHttpHandler.xml @@ -442,7 +442,7 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r .