forked from dotnet/dotnet-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHttpProtocolException.xml
102 lines (99 loc) · 6.92 KB
/
HttpProtocolException.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
<Type Name="HttpProtocolException" FullName="System.Net.Http.HttpProtocolException">
<TypeSignature Language="C#" Value="public sealed class HttpProtocolException : System.Net.Http.HttpIOException" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HttpProtocolException extends System.Net.Http.HttpIOException" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<TypeSignature Language="DocId" Value="T:System.Net.Http.HttpProtocolException" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HttpProtocolException
Inherits HttpIOException" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<TypeSignature Language="F#" Value="type HttpProtocolException = class
 inherit HttpIOException" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<TypeSignature Language="C++ CLI" Value="public ref class HttpProtocolException sealed : System::Net::Http::HttpIOException" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<TypeSignature Language="C#" Value="public sealed class HttpProtocolException : System.IO.IOException" FrameworkAlternate="net-7.0" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HttpProtocolException extends System.IO.IOException" FrameworkAlternate="net-7.0" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HttpProtocolException
Inherits IOException" FrameworkAlternate="net-7.0" />
<TypeSignature Language="F#" Value="type HttpProtocolException = class
 inherit IOException" FrameworkAlternate="net-7.0" />
<TypeSignature Language="C++ CLI" Value="public ref class HttpProtocolException sealed : System::IO::IOException" FrameworkAlternate="net-7.0" />
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Net.Http.HttpIOException</BaseTypeName>
<BaseTypeName FrameworkAlternate="net-7.0">System.IO.IOException</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>The exception thrown when an HTTP/2 or an HTTP/3 protocol error occurs.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When calling <xref:System.Net.Http.HttpClient> or <xref:System.Net.Http.SocketsHttpHandler> methods, <xref:System.Net.Http.HttpProtocolException> will be the inner exception of
<xref:System.Net.Http.HttpRequestException> if a protocol error occurs.
When calling <xref:System.IO.Stream> methods on the stream returned by <xref:System.Net.Http.HttpContent.ReadAsStream> or
<xref:System.Net.Http.HttpContent.ReadAsStreamAsync(System.Threading.CancellationToken)>, <xref:System.Net.Http.HttpProtocolException> can be thrown directly.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpProtocolException (long errorCode, string message, Exception? innerException);" FrameworkAlternate="net-10.0;net-9.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int64 errorCode, string message, class System.Exception innerException) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Http.HttpProtocolException.#ctor(System.Int64,System.String,System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (errorCode As Long, message As String, innerException As Exception)" />
<MemberSignature Language="F#" Value="new System.Net.Http.HttpProtocolException : int64 * string * Exception -> System.Net.Http.HttpProtocolException" Usage="new System.Net.Http.HttpProtocolException (errorCode, message, innerException)" />
<MemberSignature Language="C++ CLI" Value="public:
 HttpProtocolException(long errorCode, System::String ^ message, Exception ^ innerException);" />
<MemberSignature Language="C#" Value="public HttpProtocolException (long errorCode, string? message, Exception? innerException);" FrameworkAlternate="net-7.0;net-8.0" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="errorCode" Type="System.Int64" />
<Parameter Name="message" Type="System.String" />
<Parameter Name="innerException" Type="System.Exception">
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="errorCode">The HTTP/2 or HTTP/3 error code.</param>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.HttpProtocolException" /> class with the specified error code, message, and inner exception.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public long ErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 ErrorCode" />
<MemberSignature Language="DocId" Value="P:System.Net.Http.HttpProtocolException.ErrorCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As Long" />
<MemberSignature Language="F#" Value="member this.ErrorCode : int64" Usage="System.Net.Http.HttpProtocolException.ErrorCode" />
<MemberSignature Language="C++ CLI" Value="public:
 property long ErrorCode { long get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Http</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the HTTP/2 or HTTP/3 error code associated with this exception.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>