1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Http.Connections</name>
\r
7 <member name="T:Microsoft.Extensions.Internal.SecurityHelper">
\r
9 Helper code used when implementing authentication middleware
\r
12 <member name="M:Microsoft.Extensions.Internal.SecurityHelper.MergeUserPrincipal(System.Security.Claims.ClaimsPrincipal,System.Security.Claims.ClaimsPrincipal)">
\r
14 Add all ClaimsIdentities from an additional ClaimPrincipal to the ClaimsPrincipal
\r
15 Merges a new claims principal, placing all new identities first, and eliminating
\r
16 any empty unauthenticated identities from context.User
\r
18 <param name="existingPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing existing <see cref="T:System.Security.Claims.ClaimsIdentity"/>.</param>
\r
19 <param name="additionalPrincipal">The <see cref="T:System.Security.Claims.ClaimsPrincipal"/> containing <see cref="T:System.Security.Claims.ClaimsIdentity"/> to be added.</param>
\r
21 <member name="T:Microsoft.Extensions.Internal.WebEncoders">
\r
23 Contains utility APIs to assist with common encoding and decoding operations.
\r
26 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String)">
\r
28 Decodes a base64url-encoded string.
\r
30 <param name="input">The base64url-encoded input to decode.</param>
\r
31 <returns>The base64url-decoded form of the input.</returns>
\r
33 The input must not contain any whitespace or padding characters.
\r
34 Throws <see cref="T:System.FormatException"/> if the input is malformed.
\r
37 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Int32)">
\r
39 Decodes a base64url-encoded substring of a given string.
\r
41 <param name="input">A string containing the base64url-encoded input to decode.</param>
\r
42 <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
\r
43 <param name="count">The number of characters in <paramref name="input"/> to decode.</param>
\r
44 <returns>The base64url-decoded form of the input.</returns>
\r
46 The input must not contain any whitespace or padding characters.
\r
47 Throws <see cref="T:System.FormatException"/> if the input is malformed.
\r
50 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)">
\r
52 Decodes a base64url-encoded <paramref name="input"/> into a <c>byte[]</c>.
\r
54 <param name="input">A string containing the base64url-encoded input to decode.</param>
\r
55 <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>
\r
56 <param name="buffer">
\r
57 Scratch buffer to hold the <see cref="T:System.Char"/>s to decode. Array must be large enough to hold
\r
58 <paramref name="bufferOffset"/> and <paramref name="count"/> characters as well as Base64 padding
\r
59 characters. Content is not preserved.
\r
61 <param name="bufferOffset">
\r
62 The offset into <paramref name="buffer"/> at which to begin writing the <see cref="T:System.Char"/>s to decode.
\r
64 <param name="count">The number of characters in <paramref name="input"/> to decode.</param>
\r
65 <returns>The base64url-decoded form of the <paramref name="input"/>.</returns>
\r
67 The input must not contain any whitespace or padding characters.
\r
68 Throws <see cref="T:System.FormatException"/> if the input is malformed.
\r
71 <member name="M:Microsoft.Extensions.Internal.WebEncoders.GetArraySizeRequiredToDecode(System.Int32)">
\r
73 Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters
\r
74 with the <see cref="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
\r
76 <param name="count">The number of characters to decode.</param>
\r
78 The minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters.
\r
81 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[])">
\r
83 Encodes <paramref name="input"/> using base64url encoding.
\r
85 <param name="input">The binary input to encode.</param>
\r
86 <returns>The base64url-encoded form of <paramref name="input"/>.</returns>
\r
88 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Int32)">
\r
90 Encodes <paramref name="input"/> using base64url encoding.
\r
92 <param name="input">The binary input to encode.</param>
\r
93 <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
\r
94 <param name="count">The number of bytes from <paramref name="input"/> to encode.</param>
\r
95 <returns>The base64url-encoded form of <paramref name="input"/>.</returns>
\r
97 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)">
\r
99 Encodes <paramref name="input"/> using base64url encoding.
\r
101 <param name="input">The binary input to encode.</param>
\r
102 <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>
\r
103 <param name="output">
\r
104 Buffer to receive the base64url-encoded form of <paramref name="input"/>. Array must be large enough to
\r
105 hold <paramref name="outputOffset"/> characters and the full base64-encoded form of
\r
106 <paramref name="input"/>, including padding characters.
\r
108 <param name="outputOffset">
\r
109 The offset into <paramref name="output"/> at which to begin writing the base64url-encoded form of
\r
110 <paramref name="input"/>.
\r
112 <param name="count">The number of <c>byte</c>s from <paramref name="input"/> to encode.</param>
\r
114 The number of characters written to <paramref name="output"/>, less any padding characters.
\r
117 <member name="M:Microsoft.Extensions.Internal.WebEncoders.GetArraySizeRequiredToEncode(System.Int32)">
\r
119 Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>
\r
120 <see cref="T:System.Byte"/>s with the <see cref="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)"/> method.
\r
122 <param name="count">The number of characters to encode.</param>
\r
124 The minimum output <c>char[]</c> size required for encoding <paramref name="count"/> <see cref="T:System.Byte"/>s.
\r
127 <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.ReadOnlySpan{System.Byte})">
\r
129 Encodes <paramref name="input"/> using base64url encoding.
\r
131 <param name="input">The binary input to encode.</param>
\r
132 <returns>The base64url-encoded form of <paramref name="input"/>.</returns>
\r
134 <member name="T:Microsoft.Extensions.DependencyInjection.ConnectionsDependencyInjectionExtensions">
\r
136 Extension methods for <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
\r
139 <member name="M:Microsoft.Extensions.DependencyInjection.ConnectionsDependencyInjectionExtensions.AddConnections(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
\r
141 Adds required services for ASP.NET Core Connection Handlers to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
\r
143 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
\r
144 <returns>The same instance of the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for chaining.</returns>
\r
146 <member name="M:Microsoft.Extensions.DependencyInjection.ConnectionsDependencyInjectionExtensions.AddConnections(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.Http.Connections.ConnectionOptions})">
\r
148 Adds required services for ASP.NET Core Connection Handlers to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
\r
150 <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
\r
151 <param name="options">A callback to configure <see cref="T:Microsoft.AspNetCore.Http.Connections.ConnectionOptions" /></param>
\r
152 <returns>The same instance of the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> for chaining.</returns>
\r
154 <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_InvalidCountOffsetOrLength">
\r
156 Invalid {0}, {1} or {2} length.
\r
159 <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_MalformedInput">
\r
161 Malformed input: {0} is an invalid input length.
\r
164 <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_InvalidCountOffsetOrLength(System.Object,System.Object,System.Object)">
\r
166 Invalid {0}, {1} or {2} length.
\r
169 <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_MalformedInput(System.Object)">
\r
171 Malformed input: {0} is an invalid input length.
\r
174 <member name="T:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder">
\r
176 Builds conventions that will be used for customization of Connection <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
\r
179 <member name="M:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder.Add(System.Action{Microsoft.AspNetCore.Builder.EndpointBuilder})">
\r
181 Adds the specified convention to the builder. Conventions are used to customize <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
\r
183 <param name="convention">The convention to add to the builder.</param>
\r
185 <member name="M:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilderExtensions.MapConnections(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,System.Action{Microsoft.AspNetCore.Connections.IConnectionBuilder})">
\r
187 Maps incoming requests with the specified path to the provided connection pipeline.
\r
189 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
\r
190 <param name="pattern">The route pattern.</param>
\r
191 <param name="configure">A callback to configure the connection.</param>
\r
192 <returns>An <see cref="T:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder"/> for endpoints associated with the connections.</returns>
\r
194 <member name="M:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilderExtensions.MapConnectionHandler``1(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String)">
\r
196 Maps incoming requests with the specified path to the provided connection pipeline.
\r
198 <typeparam name="TConnectionHandler">The <see cref="T:Microsoft.AspNetCore.Connections.ConnectionHandler"/> type.</typeparam>
\r
199 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
\r
200 <param name="pattern">The route pattern.</param>
\r
201 <returns>An <see cref="T:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder"/> for endpoints associated with the connections.</returns>
\r
203 <member name="M:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilderExtensions.MapConnectionHandler``1(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
\r
205 Maps incoming requests with the specified path to the provided connection pipeline.
\r
207 <typeparam name="TConnectionHandler">The <see cref="T:Microsoft.AspNetCore.Connections.ConnectionHandler"/> type.</typeparam>
\r
208 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
\r
209 <param name="pattern">The route pattern.</param>
\r
210 <param name="configureOptions">A callback to configure dispatcher options.</param>
\r
211 <returns>An <see cref="T:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder"/> for endpoints associated with the connections.</returns>
\r
213 <member name="M:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilderExtensions.MapConnections(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions,System.Action{Microsoft.AspNetCore.Connections.IConnectionBuilder})">
\r
215 Maps incoming requests with the specified path to the provided connection pipeline.
\r
217 <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
\r
218 <param name="pattern">The route pattern.</param>
\r
219 <param name="options">Options used to configure the connection.</param>
\r
220 <param name="configure">A callback to configure the connection.</param>
\r
221 <returns>An <see cref="T:Microsoft.AspNetCore.Builder.ConnectionEndpointRouteBuilder"/> for endpoints associated with the connections.</returns>
\r
223 <member name="T:Microsoft.AspNetCore.Builder.ConnectionsAppBuilderExtensions">
\r
225 Extension methods for <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.
\r
228 <member name="M:Microsoft.AspNetCore.Builder.ConnectionsAppBuilderExtensions.UseConnections(Microsoft.AspNetCore.Builder.IApplicationBuilder,System.Action{Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder})">
\r
230 Adds support for ASP.NET Core Connection Handlers to the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> request execution pipeline.
\r
232 This method is obsolete and will be removed in a future version.
\r
233 The recommended alternative is to use MapConnections or MapConnectionHandler<TConnectionHandler> inside Microsoft.AspNetCore.Builder.UseEndpoints(...).
\r
236 <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
\r
237 <param name="configure">A callback to configure connection routes.</param>
\r
238 <returns>The same instance of the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> for chaining.</returns>
\r
240 <member name="P:Microsoft.AspNetCore.Http.Connections.ConnectionOptions.DisconnectTimeout">
\r
242 Gets or sets the interval used by the server to timeout idle connections.
\r
245 <member name="T:Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder">
\r
247 Maps routes to ASP.NET Core Connection Handlers.
\r
249 This class is obsolete and will be removed in a future version.
\r
250 The recommended alternative is to use MapConnection and MapConnectionHandler<TConnectionHandler> inside Microsoft.AspNetCore.Builder.UseEndpoints(...).
\r
254 <member name="M:Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder.MapConnections(Microsoft.AspNetCore.Http.PathString,System.Action{Microsoft.AspNetCore.Connections.IConnectionBuilder})">
\r
256 Maps incoming requests with the specified path to the provided connection pipeline.
\r
258 <param name="path">The request path.</param>
\r
259 <param name="configure">A callback to configure the connection.</param>
\r
261 <member name="M:Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder.MapConnections(Microsoft.AspNetCore.Http.PathString,Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions,System.Action{Microsoft.AspNetCore.Connections.IConnectionBuilder})">
\r
263 Maps incoming requests with the specified path to the provided connection pipeline.
\r
265 <param name="path">The request path.</param>
\r
266 <param name="options">Options used to configure the connection.</param>
\r
267 <param name="configure">A callback to configure the connection.</param>
\r
269 <member name="M:Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder.MapConnectionHandler``1(Microsoft.AspNetCore.Http.PathString)">
\r
271 Maps incoming requests with the specified path to the provided connection pipeline.
\r
273 <typeparam name="TConnectionHandler">The <see cref="T:Microsoft.AspNetCore.Connections.ConnectionHandler"/> type.</typeparam>
\r
274 <param name="path">The request path.</param>
\r
276 <member name="M:Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder.MapConnectionHandler``1(Microsoft.AspNetCore.Http.PathString,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
\r
278 Maps incoming requests with the specified path to the provided connection pipeline.
\r
280 <typeparam name="TConnectionHandler">The <see cref="T:Microsoft.AspNetCore.Connections.ConnectionHandler"/> type.</typeparam>
\r
281 <param name="path">The request path.</param>
\r
282 <param name="configureOptions">A callback to configure dispatcher options.</param>
\r
284 <member name="M:Microsoft.AspNetCore.Http.Connections.HttpConnectionContextExtensions.GetHttpContext(Microsoft.AspNetCore.Connections.ConnectionContext)">
\r
286 Gets the <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the connection, if there is one.
\r
288 <param name="connection">The <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext"/> representing the connection.</param>
\r
289 <returns>The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> associated with the connection, or <see langword="null"/> if the connection is not HTTP-based.</returns>
\r
291 SignalR connections can run on top of HTTP transports like WebSockets or Long Polling, or other non-HTTP transports. As a result,
\r
292 this method can sometimes return <see langword="null"/> depending on the configuration of your application.
\r
295 <member name="T:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions">
\r
297 Options used to configure the HTTP connection dispatcher.
\r
300 <member name="M:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.#ctor">
\r
302 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions"/> class.
\r
305 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.AuthorizationData">
\r
307 Gets a collection of <see cref="T:Microsoft.AspNetCore.Authorization.IAuthorizeData"/> used during HTTP connection pipeline.
\r
310 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.Transports">
\r
312 Gets or sets a bitmask combining one or more <see cref="T:Microsoft.AspNetCore.Http.Connections.HttpTransportType"/> values that specify what transports the server should use to receive HTTP requests.
\r
315 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.WebSockets">
\r
317 Gets the <see cref="T:Microsoft.AspNetCore.Http.Connections.WebSocketOptions"/> used by the web sockets transport.
\r
320 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.LongPolling">
\r
322 Gets the <see cref="T:Microsoft.AspNetCore.Http.Connections.LongPollingOptions"/> used by the long polling transport.
\r
325 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.TransportMaxBufferSize">
\r
327 Gets or sets the maximum buffer size of the transport writer.
\r
330 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.ApplicationMaxBufferSize">
\r
332 Gets or sets the maximum buffer size of the application writer.
\r
335 <member name="P:Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions.MinimumProtocolVersion">
\r
337 Gets or sets the minimum protocol verison supported by the server.
\r
338 The default value is 0, the lowest possible protocol version.
\r
341 <member name="M:Microsoft.AspNetCore.Http.Connections.Internal.HttpConnectionContext.#ctor(System.String,System.String,Microsoft.Extensions.Logging.ILogger)">
\r
343 Creates the DefaultConnectionContext without Pipes to avoid upfront allocations.
\r
344 The caller is expected to set the <see cref="P:Microsoft.AspNetCore.Http.Connections.Internal.HttpConnectionContext.Transport"/> and <see cref="P:Microsoft.AspNetCore.Http.Connections.Internal.HttpConnectionContext.Application"/> pipes manually.
\r
346 <param name="connectionId"></param>
\r
347 <param name="connectionToken"></param>
\r
348 <param name="logger"></param>
\r
350 <member name="M:Microsoft.AspNetCore.Http.Connections.Internal.HttpConnectionManager.CreateConnection(System.IO.Pipelines.PipeOptions,System.IO.Pipelines.PipeOptions,System.Int32)">
\r
352 Creates a connection without Pipes setup to allow saving allocations until Pipes are needed.
\r
354 <returns></returns>
\r
356 <member name="M:Microsoft.AspNetCore.Http.Connections.Internal.Transports.IHttpTransport.ProcessRequestAsync(Microsoft.AspNetCore.Http.HttpContext,System.Threading.CancellationToken)">
\r
358 Executes the transport
\r
360 <param name="context"></param>
\r
361 <param name="token"></param>
\r
362 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that completes when the transport has finished processing</returns>
\r
364 <member name="T:Microsoft.AspNetCore.Http.Connections.LongPollingOptions">
\r
366 Options used to configure the long polling transport.
\r
369 <member name="P:Microsoft.AspNetCore.Http.Connections.LongPollingOptions.PollTimeout">
\r
371 Gets or sets the poll timeout.
\r
374 <member name="T:Microsoft.AspNetCore.Http.Connections.NegotiateMetadata">
\r
376 Metadata to identify the /negotiate endpoint for HTTP connections
\r
379 <member name="M:Microsoft.AspNetCore.Http.Connections.ServerSentEventsMessageFormatter.GetLastSegment(System.Buffers.ReadOnlySequence{System.Byte}@,System.Int64@)">
\r
381 Gets the last memory segment in a sequence.
\r
383 <param name="source">Source sequence.</param>
\r
384 <param name="offset">The offset the segment starts at.</param>
\r
385 <returns>The last memory segment in a sequence.</returns>
\r
387 <member name="P:Microsoft.AspNetCore.Http.Connections.WebSocketOptions.SubProtocolSelector">
\r
389 Gets or sets a delegate that will be called when a new WebSocket is established to select the value
\r
390 for the 'Sec-WebSocket-Protocol' response header. The delegate will be called with a list of the protocols provided
\r
391 by the client in the 'Sec-WebSocket-Protocol' request header.
\r
394 See RFC 6455 section 1.3 for more details on the WebSocket handshake: https://tools.ietf.org/html/rfc6455#section-1.3
\r
397 <member name="T:Microsoft.AspNetCore.Internal.MemoryBufferWriter.CompletedBuffer">
\r
399 Holds a byte[] from the pool and a size value. Basically a Memory but guaranteed to be backed by an ArrayPool byte[], so that we know we can return it.
\r