Skip to content

Commit bd8da72

Browse files
author
Jan Jahoda
committed
Add Sysytem.Net.\* missing API
1 parent e47c9b2 commit bd8da72

File tree

6 files changed

+158
-66
lines changed

6 files changed

+158
-66
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">Name of the header to specify the <see cref="System.Text.Encoding"/> for.</param>
28+
<param name="context">The <typeparamref name="TContext"/> we are enoding/decoding the headers for.</param>
29+
<summary>Represents a method that specifies the <see cref="System.Text.Encoding"/> to use when interpreting header values.</summary>
30+
<returns><see cref="System.Text.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 send on 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 keep alive ping for whole connection lifetime.</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 keep alive ping for 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 encodes 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"/> indicating the default behavior.</value>
419419
<remarks>To be added.</remarks>
420420
</Docs>
421421
</Member>

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

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -350,8 +350,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
350350
<ReturnType>System.Boolean</ReturnType>
351351
</ReturnValue>
352352
<Docs>
353-
<summary>To be added.</summary>
354-
<value>To be added.</value>
353+
<summary>Gets a value that indicates whether the handler is supported on the current platform.</summary>
354+
<value>
355+
<see langword="true" /> if the handler is supported; otherwise, <see langword="false" />.</value>
355356
<remarks>To be added.</remarks>
356357
</Docs>
357358
</Member>
@@ -371,9 +372,16 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
371372
<ReturnType>System.TimeSpan</ReturnType>
372373
</ReturnValue>
373374
<Docs>
374-
<summary>To be added.</summary>
375-
<value>To be added.</value>
376-
<remarks>To be added.</remarks>
375+
<summary>Gets or sets the keep alive ping delay. 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 <see cref="System.Net.Http.SocketsHttpHandler.KeepAlivePingTimeout"/> to close broken connections.</summary>
376+
<value>The keep alive ping delay. Defaults to <see cref="Timeout.InfiniteTimeSpan"/>.</value>
377+
<remarks>
378+
<format type="text/markdown"><![CDATA[
379+
380+
## Remarks
381+
382+
Delay value must be greater than or equal to 1 second. Set to <xref:"T:System.Threading.Timeout.InfiniteTimeSpan"/> to disable the keep alive ping.
383+
384+
]]></format></remarks>
377385
</Docs>
378386
</Member>
379387
<Member MemberName="KeepAlivePingPolicy">
@@ -392,9 +400,16 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
392400
<ReturnType>System.Net.Http.HttpKeepAlivePingPolicy</ReturnType>
393401
</ReturnValue>
394402
<Docs>
395-
<summary>To be added.</summary>
396-
<value>To be added.</value>
397-
<remarks>To be added.</remarks>
403+
<summary>Gets or sets the keep alive ping behaviour.</summary>
404+
<value>The keep alive ping behaviour.</value>
405+
<remarks>
406+
<format type="text/markdown"><![CDATA[
407+
408+
## Remarks
409+
Keep alive pings are sent when a period of inactivity exceeds the configured <xref:"P:System.Net.Http.SocketsHttpHandler.KeepAlivePingDelay%2A"/> value.
410+
411+
]]></format>
412+
</remarks>
398413
</Docs>
399414
</Member>
400415
<Member MemberName="KeepAlivePingTimeout">
@@ -413,9 +428,18 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
413428
<ReturnType>System.TimeSpan</ReturnType>
414429
</ReturnValue>
415430
<Docs>
416-
<summary>To be added.</summary>
417-
<value>To be added.</value>
418-
<remarks>To be added.</remarks>
431+
<summary>Gets or sets the keep alive ping timeout.</summary>
432+
<value>The keep alive ping timeout. Defaults to 20 seconds.</value>
433+
<remarks>
434+
<format type="text/markdown"><![CDATA[
435+
436+
## Remarks
437+
Keep alive pings are sent when a period of inactivity exceeds the configured <xref:"P:System.Net.Http.SocketsHttpHandler.KeepAlivePingDelay%2A"/> value. The client will close the connection if it doesn't receive any frames within the timeout.
438+
439+
Timeout must be greater than or equal to 1 second. Set to <xref:"T:System.Threading.Timeout.InfiniteTimeSpan"/> to disable the keep alive ping timeout.
440+
441+
]]></format>
442+
</remarks>
419443
</Docs>
420444
</Member>
421445
<Member MemberName="MaxAutomaticRedirections">
@@ -666,8 +690,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r
666690
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
667691
</ReturnValue>
668692
<Docs>
669-
<summary>To be added.</summary>
670-
<value>To be added.</value>
693+
<summary>Gets or sets a callback that encodes request headers values.</summary>
694+
<value>The header encoding selector callback to decode the value for the specified response header name, or <see langword="null"/> indicating the default behavior.</value>
671695
<remarks>To be added.</remarks>
672696
</Docs>
673697
</Member>
@@ -716,8 +740,8 @@ Draining occurs when a request is cancelled or a response is disposed prior to f
716740
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
717741
</ReturnValue>
718742
<Docs>
719-
<summary>To be added.</summary>
720-
<value>To be added.</value>
743+
<summary>Gets or sets a callback that encodes response headers values.</summary>
744+
<value>The header encoding selector callback to decode the value for the specified response header name, or <see langword="null"/> indicating the default behavior.</value>
721745
<remarks>To be added.</remarks>
722746
</Docs>
723747
</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>An asynchronous Task.</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>An asynchronous Task.</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. The host is specified by an IP address and a port number.</summary>
393+
<returns>An asynchronous Task.</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. The host is specified by an array of IP addresses and a port number.</summary>
427+
<returns>A task that represents the asynchronous connect 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. The host is specified by a host name and a port number.</summary>
461+
<returns>An asynchronous task.</returns>
462462
<remarks>To be added.</remarks>
463463
</Docs>
464464
</Member>

0 commit comments

Comments
 (0)