-
Notifications
You must be signed in to change notification settings - Fork 112
/
SocketConnectionFactoryOptions.xml
192 lines (192 loc) · 10.9 KB
/
SocketConnectionFactoryOptions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<Type Name="SocketConnectionFactoryOptions" FullName="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions">
<TypeSignature Language="C#" Value="public class SocketConnectionFactoryOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SocketConnectionFactoryOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions" />
<TypeSignature Language="VB.NET" Value="Public Class SocketConnectionFactoryOptions" />
<TypeSignature Language="F#" Value="type SocketConnectionFactoryOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Options for <see cref="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionContextFactory" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SocketConnectionFactoryOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Create a new instance.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IOQueueCount">
<MemberSignature Language="C#" Value="public int IOQueueCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 IOQueueCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.IOQueueCount" />
<MemberSignature Language="VB.NET" Value="Public Property IOQueueCount As Integer" />
<MemberSignature Language="F#" Value="member this.IOQueueCount : int with get, set" Usage="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.IOQueueCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The number of I/O queues used to process requests. Set to 0 to directly schedule I/O to the ThreadPool.
</summary>
<value>To be added.</value>
<remarks>
Defaults to <see cref="P:System.Environment.ProcessorCount" /> rounded down and clamped between 1 and 16.
</remarks>
</Docs>
</Member>
<Member MemberName="MaxReadBufferSize">
<MemberSignature Language="C#" Value="public long? MaxReadBufferSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> MaxReadBufferSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxReadBufferSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxReadBufferSize As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.MaxReadBufferSize : Nullable<int64> with get, set" Usage="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxReadBufferSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum unconsumed incoming bytes the transport will buffer.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxWriteBufferSize">
<MemberSignature Language="C#" Value="public long? MaxWriteBufferSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> MaxWriteBufferSize" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxWriteBufferSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxWriteBufferSize As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.MaxWriteBufferSize : Nullable<int64> with get, set" Usage="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.MaxWriteBufferSize" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum outgoing bytes the transport will buffer before applying write backpressure.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnsafePreferInlineScheduling">
<MemberSignature Language="C#" Value="public bool UnsafePreferInlineScheduling { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UnsafePreferInlineScheduling" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.UnsafePreferInlineScheduling" />
<MemberSignature Language="VB.NET" Value="Public Property UnsafePreferInlineScheduling As Boolean" />
<MemberSignature Language="F#" Value="member this.UnsafePreferInlineScheduling : bool with get, set" Usage="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.UnsafePreferInlineScheduling" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Inline application and transport continuations instead of dispatching to the threadpool.
</summary>
<value>To be added.</value>
<remarks>
This will run application code on the IO thread which is why this is unsafe.
It is recommended to set the DOTNET_SYSTEM_NET_SOCKETS_INLINE_COMPLETIONS environment variable to '1' when using this setting to also inline the completions
at the runtime layer as well.
This setting can make performance worse if there is expensive work that will end up holding onto the IO thread for longer than needed.
Test to make sure this setting helps performance.
</remarks>
</Docs>
</Member>
<Member MemberName="WaitForDataBeforeAllocatingBuffer">
<MemberSignature Language="C#" Value="public bool WaitForDataBeforeAllocatingBuffer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool WaitForDataBeforeAllocatingBuffer" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.WaitForDataBeforeAllocatingBuffer" />
<MemberSignature Language="VB.NET" Value="Public Property WaitForDataBeforeAllocatingBuffer As Boolean" />
<MemberSignature Language="F#" Value="member this.WaitForDataBeforeAllocatingBuffer : bool with get, set" Usage="Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets.SocketConnectionFactoryOptions.WaitForDataBeforeAllocatingBuffer" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Wait until there is data available to allocate a buffer. Setting this to false can increase throughput at the cost of increased memory usage.
</summary>
<value>To be added.</value>
<remarks>
Defaults to true.
</remarks>
</Docs>
</Member>
</Members>
</Type>