508eae5c348d8b147213864d9b7dd8abd3bd94c7
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Http.Connections.Common</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.Http.Connections.AvailableTransport">\r
8             <summary>\r
9             Part of the <see cref="T:Microsoft.AspNetCore.Http.Connections.NegotiationResponse"/> that represents an individual transport and the trasfer formats the transport supports.\r
10             </summary>\r
11         </member>\r
12         <member name="P:Microsoft.AspNetCore.Http.Connections.AvailableTransport.Transport">\r
13             <summary>\r
14             A transport available on the server.\r
15             </summary>\r
16         </member>\r
17         <member name="P:Microsoft.AspNetCore.Http.Connections.AvailableTransport.TransferFormats">\r
18             <summary>\r
19             A list of formats supported by the transport. Examples include "Text" and "Binary".\r
20             </summary>\r
21         </member>\r
22         <member name="T:Microsoft.AspNetCore.Http.Connections.HttpTransports">\r
23             <summary>\r
24             Constants related to HTTP transports.\r
25             </summary>\r
26         </member>\r
27         <member name="F:Microsoft.AspNetCore.Http.Connections.HttpTransports.All">\r
28             <summary>\r
29             A bitmask combining all available <see cref="T:Microsoft.AspNetCore.Http.Connections.HttpTransportType"/> values.\r
30             </summary>\r
31         </member>\r
32         <member name="T:Microsoft.AspNetCore.Http.Connections.HttpTransportType">\r
33             <summary>\r
34             Specifies transports that the client can use to send HTTP requests.\r
35             </summary>\r
36             <remarks>\r
37             This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a bitwise combination of its member values.\r
38             </remarks>\r
39         </member>\r
40         <member name="F:Microsoft.AspNetCore.Http.Connections.HttpTransportType.None">\r
41             <summary>\r
42             Specifies that no transport is used.\r
43             </summary>\r
44         </member>\r
45         <member name="F:Microsoft.AspNetCore.Http.Connections.HttpTransportType.WebSockets">\r
46             <summary>\r
47             Specifies that the web sockets transport is used.\r
48             </summary>\r
49         </member>\r
50         <member name="F:Microsoft.AspNetCore.Http.Connections.HttpTransportType.ServerSentEvents">\r
51             <summary>\r
52             Specifies that the server sent events transport is used.\r
53             </summary>\r
54         </member>\r
55         <member name="F:Microsoft.AspNetCore.Http.Connections.HttpTransportType.LongPolling">\r
56             <summary>\r
57             Specifies that the long polling transport is used.\r
58             </summary>\r
59         </member>\r
60         <member name="T:Microsoft.AspNetCore.Http.Connections.NegotiateProtocol">\r
61             <summary>\r
62             The protocol for reading and writing negotiate requests and responses.\r
63             </summary>\r
64         </member>\r
65         <member name="M:Microsoft.AspNetCore.Http.Connections.NegotiateProtocol.WriteResponse(Microsoft.AspNetCore.Http.Connections.NegotiationResponse,System.Buffers.IBufferWriter{System.Byte})">\r
66             <summary>\r
67             Writes the <paramref name="response"/> to the <paramref name="output"/>.\r
68             </summary>\r
69             <param name="response">The negotiation response generated in response to a negotiation request.</param>\r
70             <param name="output">Where the <paramref name="response"/> is written to as Json.</param>\r
71         </member>\r
72         <member name="M:Microsoft.AspNetCore.Http.Connections.NegotiateProtocol.ParseResponse(System.ReadOnlySpan{System.Byte})">\r
73             <summary>\r
74             Parses a <see cref="T:Microsoft.AspNetCore.Http.Connections.NegotiationResponse"/> from the <paramref name="content"/> as Json.\r
75             </summary>\r
76             <param name="content">The bytes of a Json payload that represents a <see cref="T:Microsoft.AspNetCore.Http.Connections.NegotiationResponse"/>.</param>\r
77             <returns>The parsed <see cref="T:Microsoft.AspNetCore.Http.Connections.NegotiationResponse"/>.</returns>\r
78         </member>\r
79         <member name="T:Microsoft.AspNetCore.Http.Connections.NegotiationResponse">\r
80             <summary>\r
81             A response to a '/negotiate' request.\r
82             </summary>\r
83         </member>\r
84         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.Url">\r
85             <summary>\r
86             An optional Url to redirect the client to another endpoint.\r
87             </summary>\r
88         </member>\r
89         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.AccessToken">\r
90             <summary>\r
91             An optional access token to go along with the Url.\r
92             </summary>\r
93         </member>\r
94         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.ConnectionId">\r
95             <summary>\r
96             The public ID for the connection.\r
97             </summary>\r
98         </member>\r
99         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.ConnectionToken">\r
100             <summary>\r
101             The private ID for the connection.\r
102             </summary>\r
103         </member>\r
104         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.Version">\r
105             <summary>\r
106             The minimum value between the version the client sends and the maximum version the server supports.\r
107             </summary>\r
108         </member>\r
109         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.AvailableTransports">\r
110             <summary>\r
111             A list of transports the server supports.\r
112             </summary>\r
113         </member>\r
114         <member name="P:Microsoft.AspNetCore.Http.Connections.NegotiationResponse.Error">\r
115             <summary>\r
116             An optional error during the negotiate. If this is not null the other properties on the response can be ignored.\r
117             </summary>\r
118         </member>\r
119     </members>\r
120 </doc>\r