Skip to content

Add Sysytem.Net.* missing API #4904

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

Merged
merged 6 commits into from
Sep 23, 2020
Merged

Add Sysytem.Net.* missing API #4904

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e47c9b2
System.Net.Http.SocketsHttpHandler.EnableMultipleHttp2Connections
Sep 23, 2020
7e1a6ab
Add Sysytem.Net.\* missing API
Sep 23, 2020
8c0df13
Apply PR comments
Sep 23, 2020
c7362f8
Apply suggestions from code review
carlossanlop Sep 23, 2020
dc17490
Apply suggestions from code review
carlossanlop Sep 23, 2020
8ce120a
Update xml/System.Net.Http/SocketsHttpHandler.xml
carlossanlop Sep 23, 2020
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
8 changes: 4 additions & 4 deletions xml/System.Net.Http/HeaderEncodingSelector`1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
</ReturnValue>
<Docs>
<typeparam name="TContext">To be added.</typeparam>
<param name="headerName">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="headerName">The name of the header to specify for the encoding.</param>
<param name="context">The type we are encoding/decoding the headers for.</param>
<summary>Represents a method that specifies the encoding to use when interpreting header values.</summary>
<returns>The encoding to use, or <see langword="null"/> to use the default behavior.</returns>
<remarks>To be added.</remarks>
</Docs>
</Type>
6 changes: 3 additions & 3 deletions xml/System.Net.Http/HttpKeepAlivePingPolicy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<summary>Specifies when the HTTP/2 ping frame is sent on an idle connection.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,7 +34,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Sends a keep alive ping for the whole lifetime of the connection.</summary>
</Docs>
</Member>
<Member MemberName="WithActiveRequests">
Expand All @@ -54,7 +54,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Sends a keep alive ping only when there are active streams on the connection.</summary>
</Docs>
</Member>
</Members>
Expand Down
4 changes: 2 additions & 2 deletions xml/System.Net.Http/MultipartContent.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,8 +414,8 @@ This operation blocks until all of the content has been written to the memory st
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpContent&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a callback that decode response header values.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
61 changes: 44 additions & 17 deletions xml/System.Net.Http/SocketsHttpHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<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>
<value>
<see langword="true" /> if additional HTTP/2 connections are allowed to be created; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -349,8 +350,9 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets a value that indicates whether the handler is supported on the current platform.</summary>
<value>
<see langword="true" /> if the handler is supported; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -370,9 +372,18 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the keep alive ping delay.</summary>
<value>The keep alive ping delay. Defaults to <see cref="Timeout.InfiniteTimeSpan"/>.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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.

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.

]]></format></remarks>
</Docs>
</Member>
<Member MemberName="KeepAlivePingPolicy">
Expand All @@ -391,9 +402,16 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.Net.Http.HttpKeepAlivePingPolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the keep alive ping behaviour.</summary>
<value>The keep alive ping behaviour.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Keep alive pings are sent when a period of inactivity exceeds the configured <xref:"P:System.Net.Http.SocketsHttpHandler.KeepAlivePingDelay%2A"/> value.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="KeepAlivePingTimeout">
Expand All @@ -412,9 +430,18 @@ The default proxy is used only when <xref:System.Net.Http.SocketsHttpHandler.Use
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets the keep alive ping timeout.</summary>
<value>The keep alive ping timeout. Defaults to 20 seconds.</value>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
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.

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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxAutomaticRedirections">
Expand Down Expand Up @@ -665,8 +692,8 @@ For example, if the value is 64, then 65,536 bytes are allowed for the maximum r
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a callback that decodes request headers values.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -715,8 +742,8 @@ Draining occurs when a request is cancelled or a response is disposed prior to f
<ReturnType>System.Net.Http.HeaderEncodingSelector&lt;System.Net.Http.HttpRequestMessage&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<summary>Gets or sets a callback that decodes response headers values.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
48 changes: 24 additions & 24 deletions xml/System.Net.Sockets/SocketTaskExtensions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,11 +205,11 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="remoteEP">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="socket">The socket that is used for establishing a connection.</param>
<param name="remoteEP">An EndPoint that represents the remote device.</param>
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
<summary>Establishes a connection to a remote host.</summary>
<returns>A task that represents the asynchronous connection operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -258,7 +258,7 @@
<param name="address">The IP address of the remote host.</param>
<param name="port">The port number of the remote host.</param>
<summary>Establishes a connection to a remote host. The host is specified by an IP address and a port number.</summary>
<returns>To be added.</returns>
<returns>A task that represents an asynchronous connection operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -385,12 +385,12 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="address">To be added.</param>
<param name="port">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="socket">The socket to perform the connect operation on.</param>
<param name="address">The IP address of the remote host.</param>
<param name="port">The port number of the remote host.</param>
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
<summary>Establishes a connection to a remote host, which is specified by an IP address and a port number.</summary>
<returns>A task that represents the asynchronous connection operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -419,12 +419,12 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="addresses">To be added.</param>
<param name="port">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="socket">The socket that the connect operation is performed on.</param>
<param name="addresses">The IP addresses of the remote host.</param>
<param name="port">The port number of the remote host.</param>
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
<summary>Establishes a connection to a remote host, which is specified by an array of IP addresses and a port number.</summary>
<returns>A task that represents the asynchronous connection operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -453,12 +453,12 @@
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="net-5.0" />
</Parameters>
<Docs>
<param name="socket">To be added.</param>
<param name="host">To be added.</param>
<param name="port">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="socket">The socket to perform the connect operation on.</param>
<param name="host">The name of the remote host.</param>
<param name="port">The port number of the remote host.</param>
<param name="cancellationToken">A cancellation token that can be used to signal the asynchronous operation should be canceled.</param>
<summary>Establishes a connection to a remote host, which is specified by a host name and a port number.</summary>
<returns>A task that represents an asynchronous connection operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
Loading