/
HttpListenerTimeoutManager.xml
364 lines (343 loc) · 19 KB
/
HttpListenerTimeoutManager.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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<Type Name="HttpListenerTimeoutManager" FullName="System.Net.HttpListenerTimeoutManager">
<TypeSignature Language="C#" Value="public class HttpListenerTimeoutManager" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HttpListenerTimeoutManager extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Net.HttpListenerTimeoutManager" />
<TypeSignature Language="VB.NET" Value="Public Class HttpListenerTimeoutManager" />
<TypeSignature Language="F#" Value="type HttpListenerTimeoutManager = class" />
<TypeSignature Language="C++ CLI" Value="public ref class HttpListenerTimeoutManager" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
<TypeForwardingChain>
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.HttpListener" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.HttpListener" ToVersion="6.0.0.0" FrameworkAlternate="net-6.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.HttpListener" ToVersion="7.0.0.0" FrameworkAlternate="net-7.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.HttpListener" ToVersion="8.0.0.0" FrameworkAlternate="net-8.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.HttpListener" ToVersion="9.0.0.0" FrameworkAlternate="net-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>The timeout manager to use for an <see cref="T:System.Net.HttpListener" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The timeout manager defines the connection timeout limits for a <xref:System.Net.HttpListener> instance.
]]></format>
</remarks>
<altmember cref="T:System.Net.HttpListener" />
<altmember cref="T:System.Net.Configuration.HttpListenerElement" />
<altmember cref="T:System.Net.Configuration.HttpListenerTimeoutsElement" />
</Docs>
<Members>
<Member MemberName="DrainEntityBody">
<MemberSignature Language="C#" Value="public TimeSpan DrainEntityBody { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan DrainEntityBody" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.DrainEntityBody" />
<MemberSignature Language="VB.NET" Value="Public Property DrainEntityBody As TimeSpan" />
<MemberSignature Language="F#" Value="member this.DrainEntityBody : TimeSpan with get, set" Usage="System.Net.HttpListenerTimeoutManager.DrainEntityBody" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan DrainEntityBody { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time allowed for the <see cref="T:System.Net.HttpListener" /> to drain the entity body on a Keep-Alive connection.</summary>
<value>The time allowed for the <see cref="T:System.Net.HttpListener" /> to drain the entity body on a Keep-Alive connection.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value for this property is 2 minutes.
On a Keep-Alive connection, after the app has sent a response for a request and before the request entity body has completely arrived, the <xref:System.Net.HttpListener> starts draining the remainder of the entity body to reach another potentially pipelined request from the client. If the time to drain the remaining entity body exceeds the allowed period the connection is timed out.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="EntityBody">
<MemberSignature Language="C#" Value="public TimeSpan EntityBody { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan EntityBody" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.EntityBody" />
<MemberSignature Language="VB.NET" Value="Public Property EntityBody As TimeSpan" />
<MemberSignature Language="F#" Value="member this.EntityBody : TimeSpan with get, set" Usage="System.Net.HttpListenerTimeoutManager.EntityBody" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan EntityBody { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
<Attributes>
<Attribute FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[set: System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time allowed for the request entity body to arrive.</summary>
<value>The time allowed for the request entity body to arrive.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value for this property is 2 minutes.
The <xref:System.Net.HttpListener> turns on this timer when the request has an entity body. The timer expiration is initially set to the configured value. When the <xref:System.Net.HttpListener> receives additional data indications on the request, it resets the timer to give the connection another interval.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="HeaderWait">
<MemberSignature Language="C#" Value="public TimeSpan HeaderWait { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan HeaderWait" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.HeaderWait" />
<MemberSignature Language="VB.NET" Value="Public Property HeaderWait As TimeSpan" />
<MemberSignature Language="F#" Value="member this.HeaderWait : TimeSpan with get, set" Usage="System.Net.HttpListenerTimeoutManager.HeaderWait" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan HeaderWait { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
<Attributes>
<Attribute FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[set: System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time allowed for the <see cref="T:System.Net.HttpListener" /> to parse the request header.</summary>
<value>The time allowed for the <see cref="T:System.Net.HttpListener" /> to parse the request header.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value for this property is 2 minutes.
This timeout is only enforced after the first request on the connection is routed to the <xref:System.Net.HttpListener>.
The system cannot determine the request queue or URL group that the request is associated with until the headers have been parsed. Therefore, the <xref:System.Net.HttpListener> enforces the default <xref:System.Net.HttpListenerTimeoutManager.HeaderWait%2A> timer for the first request on a connection. Subsequent requests on a Keep-Alive connection will use the value set on this property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IdleConnection">
<MemberSignature Language="C#" Value="public TimeSpan IdleConnection { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan IdleConnection" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.IdleConnection" />
<MemberSignature Language="VB.NET" Value="Public Property IdleConnection As TimeSpan" />
<MemberSignature Language="F#" Value="member this.IdleConnection : TimeSpan with get, set" Usage="System.Net.HttpListenerTimeoutManager.IdleConnection" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan IdleConnection { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time allowed for an idle connection.</summary>
<value>The time allowed for an idle connection.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value for this property is 2 minutes.
This timeout is only enforced after the first request on the connection is routed to the <xref:System.Net.HttpListener>.
The system cannot determine the request queue or URL group that the request is associated with until the headers have been parsed. Therefore, the <xref:System.Net.HttpListener> enforces the default <xref:System.Net.HttpListenerTimeoutManager.IdleConnection%2A> timer for the first request on a connection. Subsequent requests on a Keep-Alive connection will use the value set on this property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MinSendBytesPerSecond">
<MemberSignature Language="C#" Value="public long MinSendBytesPerSecond { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MinSendBytesPerSecond" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.MinSendBytesPerSecond" />
<MemberSignature Language="VB.NET" Value="Public Property MinSendBytesPerSecond As Long" />
<MemberSignature Language="F#" Value="member this.MinSendBytesPerSecond : int64 with get, set" Usage="System.Net.HttpListenerTimeoutManager.MinSendBytesPerSecond" />
<MemberSignature Language="C++ CLI" Value="public:
 property long MinSendBytesPerSecond { long get(); void set(long value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
<Attributes>
<Attribute FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[set: System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the minimum send rate, in bytes-per-second, for the response.</summary>
<value>The minimum send rate, in bytes-per-second, for the response.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default response send rate is 150 bytes-per-second.
To disable this timer, set <xref:System.Net.HttpListenerTimeoutManager.MinSendBytesPerSecond%2A> to MAXULONG.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="RequestQueue">
<MemberSignature Language="C#" Value="public TimeSpan RequestQueue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan RequestQueue" />
<MemberSignature Language="DocId" Value="P:System.Net.HttpListenerTimeoutManager.RequestQueue" />
<MemberSignature Language="VB.NET" Value="Public Property RequestQueue As TimeSpan" />
<MemberSignature Language="F#" Value="member this.RequestQueue : TimeSpan with get, set" Usage="System.Net.HttpListenerTimeoutManager.RequestQueue" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan RequestQueue { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Net.HttpListener</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<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>
<Attributes>
<Attribute FrameworkAlternate="net-5.0;net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[set: System.Runtime.Versioning.SupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.Versioning.SupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time allowed for the request to remain in the request queue before the <see cref="T:System.Net.HttpListener" /> picks it up.</summary>
<value>The time allowed for the request to remain in the request queue before the <see cref="T:System.Net.HttpListener" /> picks it up.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default value for this property is 2 minutes.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>