-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathHttpCompletionOption.xml
127 lines (123 loc) · 7.22 KB
/
HttpCompletionOption.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
<Type Name="HttpCompletionOption" FullName="System.Net.Http.HttpCompletionOption">
<TypeSignature Language="C#" Value="public enum HttpCompletionOption" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed HttpCompletionOption extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.HttpCompletionOption" />
<TypeSignature Language="VB.NET" Value="Public Enum HttpCompletionOption" />
<TypeSignature Language="F#" Value="type HttpCompletionOption = " />
<TypeSignature Language="C++ CLI" Value="public enum class HttpCompletionOption" />
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.Http" ToVersion="5.0.0.0" FrameworkAlternate="net-5.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.Http" ToVersion="6.0.0.0" FrameworkAlternate="net-6.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.Http" ToVersion="7.0.0.0" FrameworkAlternate="net-7.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.Http" ToVersion="8.0.0.0" FrameworkAlternate="net-8.0" />
<TypeForwarding From="netstandard" FromVersion="2.1.0.0" To="System.Net.Http" ToVersion="9.0.0.0" FrameworkAlternate="net-9.0" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Indicates if <see cref="T:System.Net.Http.HttpClient" /> operations should be considered completed either as soon as a response is available, or after reading the entire response message including the content.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!WARNING]
> The <xref:System.Net.Http.HttpCompletionOption> value affects the scope of the timeout specified in the <xref:System.Net.Http.HttpClient> options when reading a response. The timeout on the <xref:System.Net.Http.HttpClient> always applies on the relevant invoked methods up until the point where those methods complete/return. Crucially, when using the <xref:System.Net.Http.HttpCompletionOption.ResponseHeadersRead> option, the timeout applies only up to where the headers end and the content starts. The content reading operation needs to be timed out separately in case the server promptly returns the status line and headers but takes too long to return the content.
> This consideration also applies to the <xref:System.Net.Http.HttpClient.MaxResponseContentBufferSize%2A> property. The limit is only enforced when using <xref:System.Net.Http.HttpCompletionOption.ResponseContentRead>.
> Below is an example illustrating this point:
:::code language="csharp" source="~/snippets/csharp/System.Net.Http/HttpCompletionOption/HttpCompletionOptionSnippets.cs" id="SnippetHttpCompletionOption":::
]]>
</format>
</remarks>
</Docs>
<Members>
<Member MemberName="ResponseContentRead">
<MemberSignature Language="C#" Value="ResponseContentRead" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Http.HttpCompletionOption ResponseContentRead = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.Net.Http.HttpCompletionOption.ResponseContentRead" />
<MemberSignature Language="VB.NET" Value="ResponseContentRead" />
<MemberSignature Language="F#" Value="ResponseContentRead = 0" Usage="System.Net.Http.HttpCompletionOption.ResponseContentRead" />
<MemberSignature Language="C++ CLI" Value="ResponseContentRead" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Http.HttpCompletionOption</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>The operation should complete after reading the entire response including the content.</summary>
</Docs>
</Member>
<Member MemberName="ResponseHeadersRead">
<MemberSignature Language="C#" Value="ResponseHeadersRead" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Net.Http.HttpCompletionOption ResponseHeadersRead = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Net.Http.HttpCompletionOption.ResponseHeadersRead" />
<MemberSignature Language="VB.NET" Value="ResponseHeadersRead" />
<MemberSignature Language="F#" Value="ResponseHeadersRead = 1" Usage="System.Net.Http.HttpCompletionOption.ResponseHeadersRead" />
<MemberSignature Language="C++ CLI" Value="ResponseHeadersRead" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.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>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.Http.HttpCompletionOption</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The operation should complete as soon as a response is available and headers are read. The content is not read yet.</summary>
</Docs>
</Member>
</Members>
</Type>