-
Notifications
You must be signed in to change notification settings - Fork 112
/
IHttpRequestBodyDetectionFeature.xml
72 lines (72 loc) · 4.1 KB
/
IHttpRequestBodyDetectionFeature.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
<Type Name="IHttpRequestBodyDetectionFeature" FullName="Microsoft.AspNetCore.Http.Features.IHttpRequestBodyDetectionFeature">
<TypeSignature Language="C++ CLI" Value="public interface class IHttpRequestBodyDetectionFeature" />
<TypeSignature Language="C#" Value="public interface IHttpRequestBodyDetectionFeature" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IHttpRequestBodyDetectionFeature" FrameworkAlternate="aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Http.Features.IHttpRequestBodyDetectionFeature" />
<TypeSignature Language="VB.NET" Value="Public Interface IHttpRequestBodyDetectionFeature" />
<TypeSignature Language="F#" Value="type IHttpRequestBodyDetectionFeature = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IHttpRequestBodyDetectionFeature" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Features</AssemblyName>
<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>
<Interfaces />
<Docs>
<summary>
Used to indicate if the request can have a body.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CanHaveBody">
<MemberSignature Language="C++ CLI" Value="public:
 property bool CanHaveBody { bool get(); };" />
<MemberSignature Language="C#" Value="public bool CanHaveBody { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanHaveBody" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Http.Features.IHttpRequestBodyDetectionFeature.CanHaveBody" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanHaveBody As Boolean" />
<MemberSignature Language="F#" Value="member this.CanHaveBody : bool" Usage="Microsoft.AspNetCore.Http.Features.IHttpRequestBodyDetectionFeature.CanHaveBody" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Http.Features</AssemblyName>
<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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates if the request can have a body.
</summary>
<value>To be added.</value>
<remarks>
This returns true when:
<list type="bullet"><item><description>
It's an HTTP/1.x request with a non-zero Content-Length or a 'Transfer-Encoding: chunked' header.
</description></item><item><description>
It's an HTTP/2 request that did not set the END_STREAM flag on the initial headers frame.
</description></item></list>
The final request body length may still be zero for the chunked or HTTP/2 scenarios.
<para>
This returns false when:
<list type="bullet"><item><description>
It's an HTTP/1.x request with no Content-Length or 'Transfer-Encoding: chunked' header, or the Content-Length is 0.
</description></item><item><description>
It's an HTTP/1.x request with Connection: Upgrade (e.g. WebSockets). There is no HTTP request body for these requests and
no data should be received until after the upgrade.
</description></item><item><description>
It's an HTTP/2 request that set END_STREAM on the initial headers frame.
</description></item></list></para>
When false, the request body should never return data.
</remarks>
</Docs>
</Member>
</Members>
</Type>