SocketsHttpHandlerOptions.xml

<TypeName="SocketsHttpHandlerOptions"FullName="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions">
 <TypeSignatureLanguage="C#"Value="public class SocketsHttpHandlerOptions" />
 <TypeSignatureLanguage="ILAsm"Value=".class public auto ansi beforefieldinit SocketsHttpHandlerOptions extends System.Object" />
 <TypeSignatureLanguage="DocId"Value="T:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions" />
 <TypeSignatureLanguage="VB.NET"Value="Public Class SocketsHttpHandlerOptions" />
 <TypeSignatureLanguage="F#"Value="type SocketsHttpHandlerOptions = class" />
 <TypeSignatureLanguage="C++ CLI"Value="public ref class SocketsHttpHandlerOptions" />
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Base>
 <BaseTypeName>System.Object</BaseTypeName>
 </Base>
 <Interfaces />
 <Docs>
 <summary>Provides a state bag of settings for configuring <seecref="T:System.Net.Http.SocketsHttpHandler" />.</summary>
 <remarks>To be added.</remarks>
 </Docs>
 <Members>
 <MemberMemberName=".ctor">
 <MemberSignatureLanguage="C#"Value="public SocketsHttpHandlerOptions ();" />
 <MemberSignatureLanguage="ILAsm"Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
 <MemberSignatureLanguage="DocId"Value="M:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.#ctor" />
 <MemberSignatureLanguage="VB.NET"Value="Public Sub New ()" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; SocketsHttpHandlerOptions();" />
 <MemberType>Constructor</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Parameters />
 <Docs>
 <summary>To be added.</summary>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="AllowAutoRedirect">
 <MemberSignatureLanguage="C#"Value="public bool AllowAutoRedirect { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance bool AllowAutoRedirect" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.AllowAutoRedirect" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property AllowAutoRedirect As Boolean" />
 <MemberSignatureLanguage="F#"Value="member this.AllowAutoRedirect : bool with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.AllowAutoRedirect" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property bool AllowAutoRedirect { bool get(); void set(bool value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Boolean</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets a value indicating whether to automatically follow redirection responses.
 </summary>
 <value>
 The default value is <seelangword="false" />.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="AutomaticDecompression">
 <MemberSignatureLanguage="C#"Value="public System.Net.DecompressionMethods AutomaticDecompression { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.Net.DecompressionMethods AutomaticDecompression" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.AutomaticDecompression" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property AutomaticDecompression As DecompressionMethods" />
 <MemberSignatureLanguage="F#"Value="member this.AutomaticDecompression : System.Net.DecompressionMethods with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.AutomaticDecompression" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property System::Net::DecompressionMethods AutomaticDecompression { System::Net::DecompressionMethods get(); void set(System::Net::DecompressionMethods value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Net.DecompressionMethods</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets the type of decompression method used by the handler for automatic decompression of the HTTP content response.
 </summary>
 <value>
 The default value is `All`.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="ConnectTimeout">
 <MemberSignatureLanguage="C#"Value="public TimeSpan ConnectTimeout { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan ConnectTimeout" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.ConnectTimeout" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property ConnectTimeout As TimeSpan" />
 <MemberSignatureLanguage="F#"Value="member this.ConnectTimeout : TimeSpan with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.ConnectTimeout" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property TimeSpan ConnectTimeout { TimeSpan get(); void set(TimeSpan value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.TimeSpan</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error.
 </summary>
 <value>
 The default value is 10 seconds. 100 minutes is the max timeout value in Azure SLB.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="KeepAlivePingDelay">
 <MemberSignatureLanguage="C#"Value="public TimeSpan KeepAlivePingDelay { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan KeepAlivePingDelay" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.KeepAlivePingDelay" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property KeepAlivePingDelay As TimeSpan" />
 <MemberSignatureLanguage="F#"Value="member this.KeepAlivePingDelay : TimeSpan with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.KeepAlivePingDelay" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property TimeSpan KeepAlivePingDelay { TimeSpan get(); void set(TimeSpan value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.TimeSpan</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets the keep alive ping delay.
 </summary>
 <value>
 The default value is 1 minute.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="KeepAlivePingTimeout">
 <MemberSignatureLanguage="C#"Value="public TimeSpan KeepAlivePingTimeout { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan KeepAlivePingTimeout" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.KeepAlivePingTimeout" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property KeepAlivePingTimeout As TimeSpan" />
 <MemberSignatureLanguage="F#"Value="member this.KeepAlivePingTimeout : TimeSpan with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.KeepAlivePingTimeout" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property TimeSpan KeepAlivePingTimeout { TimeSpan get(); void set(TimeSpan value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.TimeSpan</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets the keep alive ping timeout.
 </summary>
 <value>
 The default value is 30 seconds.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="MaxConnectionsPerServer">
 <MemberSignatureLanguage="C#"Value="public int MaxConnectionsPerServer { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance int32 MaxConnectionsPerServer" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.MaxConnectionsPerServer" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property MaxConnectionsPerServer As Integer" />
 <MemberSignatureLanguage="F#"Value="member this.MaxConnectionsPerServer : int with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.MaxConnectionsPerServer" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property int MaxConnectionsPerServer { int get(); void set(int value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <Attributes>
 <Attribute>
 <AttributeNameLanguage="C#">[System.ComponentModel.DataAnnotations.Range(1, 100000)]</AttributeName>
 <AttributeNameLanguage="F#">[&lt;System.ComponentModel.DataAnnotations.Range(1, 100000)&gt;]</AttributeName>
 </Attribute>
 </Attributes>
 <ReturnValue>
 <ReturnType>System.Int32</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets the maximum number of concurrent connections (per server endpoint) allowed when making requests.
 </summary>
 <value>
 The default value is `100000`.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="PooledConnectionIdleTimeout">
 <MemberSignatureLanguage="C#"Value="public TimeSpan PooledConnectionIdleTimeout { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan PooledConnectionIdleTimeout" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.PooledConnectionIdleTimeout" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property PooledConnectionIdleTimeout As TimeSpan" />
 <MemberSignatureLanguage="F#"Value="member this.PooledConnectionIdleTimeout : TimeSpan with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.PooledConnectionIdleTimeout" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property TimeSpan PooledConnectionIdleTimeout { TimeSpan get(); void set(TimeSpan value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.TimeSpan</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets how long a connection can be idle in the pool to be considered reusable.
 </summary>
 <value>
 The default value is 3 minutes.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="PooledConnectionLifetime">
 <MemberSignatureLanguage="C#"Value="public TimeSpan PooledConnectionLifetime { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance valuetype System.TimeSpan PooledConnectionLifetime" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.PooledConnectionLifetime" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property PooledConnectionLifetime As TimeSpan" />
 <MemberSignatureLanguage="F#"Value="member this.PooledConnectionLifetime : TimeSpan with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.PooledConnectionLifetime" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property TimeSpan PooledConnectionLifetime { TimeSpan get(); void set(TimeSpan value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.TimeSpan</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets how long a connection can be in the pool to be considered reusable.
 </summary>
 <value>
 The default value is 5 minutes.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 <MemberMemberName="UseCookies">
 <MemberSignatureLanguage="C#"Value="public bool UseCookies { get; set; }" />
 <MemberSignatureLanguage="ILAsm"Value=".property instance bool UseCookies" />
 <MemberSignatureLanguage="DocId"Value="P:Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.UseCookies" />
 <MemberSignatureLanguage="VB.NET"Value="Public Property UseCookies As Boolean" />
 <MemberSignatureLanguage="F#"Value="member this.UseCookies : bool with get, set"Usage="Microsoft.Extensions.HttpClient.SocketHandling.SocketsHttpHandlerOptions.UseCookies" />
 <MemberSignatureLanguage="C++ CLI"Value="public:&#xA; property bool UseCookies { bool get(); void set(bool value); };" />
 <MemberType>Property</MemberType>
 <AssemblyInfo>
 <AssemblyName>Microsoft.Extensions.HttpClient.SocketHandling</AssemblyName>
 <AssemblyVersion>8.0.0.0</AssemblyVersion>
 </AssemblyInfo>
 <ReturnValue>
 <ReturnType>System.Boolean</ReturnType>
 </ReturnValue>
 <Docs>
 <summary>
 Gets or sets a value indicating whether to use cookies when sending requests.
 </summary>
 <value>
 The default value is <seelangword="false" />.
 </value>
 <remarks>To be added.</remarks>
 </Docs>
 </Member>
 </Members>
</Type>