Skip to content

Commit f6775a5

Browse files
Jan JahodaJan Jahodacarlossanlop
authored and
gewarren
committed
Add Sysytem.Net.* missing API (dotnet#4904)
* System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections * Add Sysytem.Net.\* missing API * Apply PR comments * Apply suggestions from code review * Apply suggestions from code review * Update xml/System.Net.Http/SocketsHttpHandler.xml Co-authored-by: Jan Jahoda <[email protected]> Co-authored-by: Carlos Sanchez <[email protected]>
1 parent acae6fd commit f6775a5

File tree

6 files changed

+162
-68
lines changed

6 files changed

+162
-68
lines changed

‎xml/System.Net.Http/HeaderEncodingSelector`1.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
</ReturnValue>
2525
<Docs>
2626
<typeparam name="TContext">To be added.</typeparam>
27-
<param name="headerName">To be added.</param>
28-
<param name="context">To be added.</param>
29-
<summary>To be added.</summary>
30-
<returns>To be added.</returns>
27+
<param name="headerName">The name of the header to specify for the encoding.</param>
28+
<param name="context">The type we are encoding/decoding the headers for.</param>
29+
<summary>Represents a method that specifies the encoding to use when interpreting header values.</summary>
30+
<returns>The encoding to use, or <see langword="null"/> to use the default behavior.</returns>
3131
<remarks>To be added.</remarks>
3232
</Docs>
3333
</Type>

‎xml/System.Net.Http/HttpKeepAlivePingPolicy.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
16+
<summary>Specifies when the HTTP/2 ping frame is sent on an idle connection.</summary>
1717
<remarks>To be added.</remarks>
1818
</Docs>
1919
<Members>
@@ -34,7 +34,7 @@
3434
</ReturnValue>
3535
<MemberValue>1</MemberValue>
3636
<Docs>
37-
<summary>To be added.</summary>
37+
<summary>Sends a keep alive ping for the whole lifetime of the connection.</summary>
3838
</Docs>
3939
</Member>
4040
<Member MemberName="WithActiveRequests">
@@ -54,7 +54,7 @@
5454
</ReturnValue>
5555
<MemberValue>0</MemberValue>
5656
<Docs>
57-
<summary>To be added.</summary>
57+
<summary>Sends a keep alive ping only when there are active streams on the connection.</summary>
5858
</Docs>
5959
</Member>
6060
</Members>

‎xml/System.Net.Http/MultipartContent.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -414,8 +414,8 @@ This operation blocks until all of the content has been written to the memory st
414414
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpContent&gt;</ReturnType>
415415
</ReturnValue>
416416
<Docs>
417-
<summary>To be added.</summary>
418-
<value>To be added.</value>
417+
<summary>Gets or sets a callback that decode response header values.</summary>
418+
<value>The header encoding selector callback to decode the value for the specified response header name, or <see langword="null"/> to indicate the default behavior.</value>
419419
<remarks>To be added.</remarks>
420420
</Docs>
421421
</Member>

‎xml/System.Net.Http/SocketsHttpHandler.xml

Lines changed: 44 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
304304
<ReturnType>System.Boolean</ReturnType>
305305
</ReturnValue>
306306
<Docs>
307-
<summary>To be added.</summary>
308-
<value>To be added.</value>
307+
<summary>Gets or sets a value that indicates whether additional HTTP/2 connections can be established to the same server when the maximum number of concurrent streams is reached on all existing connections.</summary>
308+
<value>
309+
<see langword="true" /> if additional HTTP/2 connections are allowed to be created; otherwise, <see langword="false" />.</value>
309310
<remarks>To be added.</remarks>
310311
</Docs>
311312
</Member>
@@ -355,8 +356,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
355356
<ReturnType>System.Boolean</ReturnType>
356357
</ReturnValue>
357358
<Docs>
358-
<summary>To be added.</summary>
359-
<value>To be added.</value>
359+
<summary>Gets a value that indicates whether the handler is supported on the current platform.</summary>
360+
<value>
361+
<see langword="true" /> if the handler is supported; otherwise, <see langword="false" />.</value>
360362
<remarks>To be added.</remarks>
361363
</Docs>
362364
</Member>
@@ -376,9 +378,18 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
376378
<ReturnType>System.TimeSpan</ReturnType>
377379
</ReturnValue>
378380
<Docs>
379-
<summary>To be added.</summary>
380-
<value>To be added.</value>
381-
<remarks>To be added.</remarks>
381+
<summary>Gets or sets the keep alive ping delay.</summary>
382+
<value>The keep alive ping delay. Defaults to <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" />.</value>
383+
<remarks>
384+
<format type="text/markdown"><![CDATA[
385+
386+
## Remarks
387+
388+
The client will send a keep alive ping to the server if it doesn't receive any frames on a connection for this period of time. This property is used together with <xref:"P:System.Net.Http.SocketsHttpHandler.KeepAlivePingTimeout%2A" /> to check whether the connection is broken.
389+
390+
Delay value must be greater than or equal to 1 second. Set to <xref:System.Threading.Timeout.InfiniteTimeSpan> to disable the keep alive ping.
391+
392+
]]></format></remarks>
382393
</Docs>
383394
</Member>
384395
<Member MemberName="KeepAlivePingPolicy">
@@ -397,9 +408,16 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
397408
<ReturnType>System.Net.Http.HttpKeepAlivePingPolicy</ReturnType>
398409
</ReturnValue>
399410
<Docs>
400-
<summary>To be added.</summary>
401-
<value>To be added.</value>
402-
<remarks>To be added.</remarks>
411+
<summary>Gets or sets the keep alive ping behaviour.</summary>
412+
<value>The keep alive ping behaviour.</value>
413+
<remarks>
414+
<format type="text/markdown"><![CDATA[
415+
416+
## Remarks
417+
Keep alive pings are sent when a period of inactivity exceeds the configured <xref:System.Net.Http.SocketsHttpHandler.KeepAlivePingDelay> value.
418+
419+
]]></format>
420+
</remarks>
403421
</Docs>
404422
</Member>
405423
<Member MemberName="KeepAlivePingTimeout">
@@ -418,9 +436,18 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
418436
<ReturnType>System.TimeSpan</ReturnType>
419437
</ReturnValue>
420438
<Docs>
421-
<summary>To be added.</summary>
422-
<value>To be added.</value>
423-
<remarks>To be added.</remarks>
439+
<summary>Gets or sets the keep alive ping timeout.</summary>
440+
<value>The keep alive ping timeout. Defaults to 20 seconds.</value>
441+
<remarks>
442+
<format type="text/markdown"><![CDATA[
443+
444+
## Remarks
445+
Keep alive pings are sent when a period of inactivity exceeds the configured <xref:System.Net.Http.SocketsHttpHandler.KeepAlivePingDelay> value. The client will close the connection if it doesn't receive any frames within the timeout.
446+
447+
Timeout must be greater than or equal to 1 second. Set to <xref:System.Threading.Timeout.InfiniteTimeSpan> to disable the keep alive ping timeout.
448+
449+
]]></format>
450+
</remarks>
424451
</Docs>
425452
</Member>
426453
<Member MemberName="MaxAutomaticRedirections">
@@ -671,8 +698,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r
671698
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
672699
</ReturnValue>
673700
<Docs>
674-
<summary>To be added.</summary>
675-
<value>To be added.</value>
701+
<summary>Gets or sets a callback that decodes request headers values.</summary>
702+
<value>The header encoding selector callback to decode the value for the specified response header name, or <see langword="null"/> to indicate the default behavior.</value>
676703
<remarks>To be added.</remarks>
677704
</Docs>
678705
</Member>
@@ -721,8 +748,8 @@ Draining occurs when a request is cancelled or a response is disposed prior to f
721748
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
722749
</ReturnValue>
723750
<Docs>
724-
<summary>To be added.</summary>
725-
<value>To be added.</value>
751+
<summary>Gets or sets a callback that decodes response headers values.</summary>
752+
<value>The header encoding selector callback to decode the value for the specified response header name, or <see langword="null"/> to indicate the default behavior.</value>
726753
<remarks>To be added.</remarks>
727754
</Docs>
728755
</Member>

‎xml/System.Net.Sockets/SocketTaskExtensions.xml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,11 @@
205205
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-5.0" />
206206
</Parameters>
207207
<Docs>
208-
<param name="socket">To be added.</param>
209-
<param name="remoteEP">To be added.</param>
210-
<param name="cancellationToken">To be added.</param>
211-
<summary>To be added.</summary>
212-
<returns>To be added.</returns>
208+
<param name="socket">The socket that is used for establishing a connection.</param>
209+
<param name="remoteEP">An EndPoint that represents the remote device.</param>
210+
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
211+
<summary>Establishes a connection to a remote host.</summary>
212+
<returns>A task that represents the asynchronous connection operation.</returns>
213213
<remarks>To be added.</remarks>
214214
</Docs>
215215
</Member>
@@ -258,7 +258,7 @@
258258
<param name="address">The IP address of the remote host.</param>
259259
<param name="port">The port number of the remote host.</param>
260260
<summary>Establishes a connection to a remote host. The host is specified by an IP address and a port number.</summary>
261-
<returns>To be added.</returns>
261+
<returns>A task that represents an asynchronous connection operation.</returns>
262262
<remarks>To be added.</remarks>
263263
</Docs>
264264
</Member>
@@ -385,12 +385,12 @@
385385
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
386386
</Parameters>
387387
<Docs>
388-
<param name="socket">To be added.</param>
389-
<param name="address">To be added.</param>
390-
<param name="port">To be added.</param>
391-
<param name="cancellationToken">To be added.</param>
392-
<summary>To be added.</summary>
393-
<returns>To be added.</returns>
388+
<param name="socket">The socket to perform the connect operation on.</param>
389+
<param name="address">The IP address of the remote host.</param>
390+
<param name="port">The port number of the remote host.</param>
391+
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
392+
<summary>Establishes a connection to a remote host, which is specified by an IP address and a port number.</summary>
393+
<returns>A task that represents the asynchronous connection operation.</returns>
394394
<remarks>To be added.</remarks>
395395
</Docs>
396396
</Member>
@@ -419,12 +419,12 @@
419419
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
420420
</Parameters>
421421
<Docs>
422-
<param name="socket">To be added.</param>
423-
<param name="addresses">To be added.</param>
424-
<param name="port">To be added.</param>
425-
<param name="cancellationToken">To be added.</param>
426-
<summary>To be added.</summary>
427-
<returns>To be added.</returns>
422+
<param name="socket">The socket that the connect operation is performed on.</param>
423+
<param name="addresses">The IP addresses of the remote host.</param>
424+
<param name="port">The port number of the remote host.</param>
425+
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
426+
<summary>Establishes a connection to a remote host, which is specified by an array of IP addresses and a port number.</summary>
427+
<returns>A task that represents the asynchronous connection operation.</returns>
428428
<remarks>To be added.</remarks>
429429
</Docs>
430430
</Member>
@@ -453,12 +453,12 @@
453453
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
454454
</Parameters>
455455
<Docs>
456-
<param name="socket">To be added.</param>
457-
<param name="host">To be added.</param>
458-
<param name="port">To be added.</param>
459-
<param name="cancellationToken">To be added.</param>
460-
<summary>To be added.</summary>
461-
<returns>To be added.</returns>
456+
<param name="socket">The socket to perform the connect operation on.</param>
457+
<param name="host">The name of the remote host.</param>
458+
<param name="port">The port number of the remote host.</param>
459+
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
460+
<summary>Establishes a connection to a remote host, which is specified by a host name and a port number.</summary>
461+
<returns>A task that represents an asynchronous connection operation.</returns>
462462
<remarks>To be added.</remarks>
463463
</Docs>
464464
</Member>

0 commit comments

Comments
 (0)