1 <?xml version="1.0"?>
\r
4 <name>Microsoft.AspNetCore.Connections.Abstractions</name>
\r
7 <member name="T:Microsoft.Extensions.Internal.ActivatorUtilities">
\r
9 Helper code for the various activator services.
\r
12 <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance(System.IServiceProvider,System.Type,System.Object[])">
\r
14 Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.
\r
16 <param name="provider">The service provider used to resolve dependencies</param>
\r
17 <param name="instanceType">The type to activate</param>
\r
18 <param name="parameters">Constructor arguments not provided by the <paramref name="provider"/>.</param>
\r
19 <returns>An activated object of type instanceType</returns>
\r
21 <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])">
\r
23 Create a delegate that will instantiate a type with constructor arguments provided directly
\r
24 and/or from an <see cref="T:System.IServiceProvider"/>.
\r
26 <param name="instanceType">The type to activate</param>
\r
27 <param name="argumentTypes">
\r
28 The types of objects, in order, that will be passed to the returned function as its second parameter
\r
31 A factory that will instantiate instanceType using an <see cref="T:System.IServiceProvider"/>
\r
32 and an argument array containing objects matching the types defined in argumentTypes
\r
35 <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])">
\r
37 Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.
\r
39 <typeparam name="T">The type to activate</typeparam>
\r
40 <param name="provider">The service provider used to resolve dependencies</param>
\r
41 <param name="parameters">Constructor arguments not provided by the <paramref name="provider"/>.</param>
\r
42 <returns>An activated object of type T</returns>
\r
44 <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)">
\r
46 Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.
\r
48 <typeparam name="T">The type of the service</typeparam>
\r
49 <param name="provider">The service provider used to resolve dependencies</param>
\r
50 <returns>The resolved service or created instance</returns>
\r
52 <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance(System.IServiceProvider,System.Type)">
\r
54 Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.
\r
56 <param name="provider">The service provider</param>
\r
57 <param name="type">The type of the service</param>
\r
58 <returns>The resolved service or created instance</returns>
\r
60 <member name="T:Microsoft.Extensions.Internal.ActivatorUtilitiesConstructorAttribute">
\r
62 Marks the constructor to be used when activating type using <see cref="T:Microsoft.Extensions.Internal.ActivatorUtilities"/>.
\r
65 <member name="T:Microsoft.Extensions.Internal.ObjectFactory">
\r
67 The result of <see cref="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])"/>.
\r
69 <param name="serviceProvider">The <see cref="T:System.IServiceProvider"/> to get service arguments from.</param>
\r
70 <param name="arguments">Additional constructor arguments.</param>
\r
71 <returns>The instantiated type.</returns>
\r
73 <member name="T:Microsoft.AspNetCore.Connections.ConnectionContext">
\r
75 Encapsulates all information about an individual connection.
\r
78 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.ConnectionId">
\r
80 Gets or sets a unique identifier to represent this connection in trace logs.
\r
83 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Features">
\r
85 Gets the collection of features provided by the server and middleware available on this connection.
\r
88 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Items">
\r
90 Gets or sets a key/value collection that can be used to share data within the scope of this connection.
\r
93 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Transport">
\r
95 Gets or sets the <see cref="T:System.IO.Pipelines.IDuplexPipe"/> that can be used to read or write data on this connection.
\r
98 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.ConnectionClosed">
\r
100 Triggered when the client connection is closed.
\r
103 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.LocalEndPoint">
\r
105 Gets or sets the local endpoint for this connection.
\r
108 <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.RemoteEndPoint">
\r
110 Gets or sets the remote endpoint for this connection.
\r
113 <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.Abort(Microsoft.AspNetCore.Connections.ConnectionAbortedException)">
\r
115 Aborts the underlying connection.
\r
117 <param name="abortReason">An optional <see cref="T:Microsoft.AspNetCore.Connections.ConnectionAbortedException"/> describing the reason the connection is being terminated.</param>
\r
119 <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.Abort">
\r
121 Aborts the underlying connection.
\r
124 <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.DisposeAsync">
\r
126 Releases resources for the underlying connection.
\r
128 <returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> that completes when resources have been released.</returns>
\r
130 <member name="T:Microsoft.AspNetCore.Connections.ConnectionDelegate">
\r
132 A function that can process a connection.
\r
134 <param name="connection">A <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext" /> representing the connection.</param>
\r
135 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the connection lifetime. When the task completes, the connection will be closed.</returns>
\r
137 <member name="T:Microsoft.AspNetCore.Connections.ConnectionHandler">
\r
139 Represents an end point that multiple connections connect to. For HTTP, endpoints are URLs, for non HTTP it can be a TCP listener (or similar)
\r
142 <member name="M:Microsoft.AspNetCore.Connections.ConnectionHandler.OnConnectedAsync(Microsoft.AspNetCore.Connections.ConnectionContext)">
\r
144 Called when a new connection is accepted to the endpoint
\r
146 <param name="connection">The new <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext"/></param>
\r
147 <returns>A <see cref="T:System.Threading.Tasks.Task"/> that represents the connection lifetime. When the task completes, the connection is complete.</returns>
\r
149 <member name="M:Microsoft.AspNetCore.Connections.DefaultConnectionContext.#ctor(System.String)">
\r
151 Creates the DefaultConnectionContext without Pipes to avoid upfront allocations.
\r
152 The caller is expected to set the <see cref="P:Microsoft.AspNetCore.Connections.DefaultConnectionContext.Transport"/> and <see cref="P:Microsoft.AspNetCore.Connections.DefaultConnectionContext.Application"/> pipes manually.
\r
154 <param name="id"></param>
\r
156 <member name="T:Microsoft.AspNetCore.Connections.Features.IConnectionCompleteFeature">
\r
158 Represents the completion action for a connection.
\r
161 <member name="M:Microsoft.AspNetCore.Connections.Features.IConnectionCompleteFeature.OnCompleted(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">
\r
163 Registers a callback to be invoked after a connection has fully completed processing. This is
\r
164 intended for resource cleanup.
\r
166 <param name="callback">The callback to invoke after the connection has completed processing.</param>
\r
167 <param name="state">The state to pass into the callback.</param>
\r
169 <member name="T:Microsoft.AspNetCore.Connections.Features.IConnectionInherentKeepAliveFeature">
\r
171 Indicates if the connection transport has an "inherent keep-alive", which means that the transport will automatically
\r
172 inform the client that it is still present.
\r
175 The most common example of this feature is the Long Polling HTTP transport, which must (due to HTTP limitations) terminate
\r
176 each poll within a particular interval and return a signal indicating "the server is still here, but there is no data yet".
\r
177 This feature allows applications to add keep-alive functionality, but limit it only to transports that don't have some kind
\r
178 of inherent keep-alive.
\r
181 <member name="T:Microsoft.AspNetCore.Connections.FileHandleType">
\r
183 Enumerates the <see cref="T:Microsoft.AspNetCore.Connections.FileHandleEndPoint"/> types.
\r
186 <member name="T:Microsoft.AspNetCore.Connections.IConnectionBuilder">
\r
188 Defines an interface that provides the mechanisms to configure a connection pipeline.
\r
191 <member name="P:Microsoft.AspNetCore.Connections.IConnectionBuilder.ApplicationServices">
\r
193 Gets the <see cref="T:System.IServiceProvider"/> that provides access to the application's service container.
\r
196 <member name="M:Microsoft.AspNetCore.Connections.IConnectionBuilder.Use(System.Func{Microsoft.AspNetCore.Connections.ConnectionDelegate,Microsoft.AspNetCore.Connections.ConnectionDelegate})">
\r
198 Adds a middleware delegate to the application's connection pipeline.
\r
200 <param name="middleware">The middleware delegate.</param>
\r
201 <returns>The <see cref="T:Microsoft.AspNetCore.Connections.IConnectionBuilder"/>.</returns>
\r
203 <member name="M:Microsoft.AspNetCore.Connections.IConnectionBuilder.Build">
\r
205 Builds the delegate used by this application to process connections.
\r
207 <returns>The connection handling delegate.</returns>
\r
209 <member name="T:Microsoft.AspNetCore.Connections.IConnectionFactory">
\r
211 A factory abstraction for creating connections to an endpoint.
\r
214 <member name="M:Microsoft.AspNetCore.Connections.IConnectionFactory.ConnectAsync(System.Net.EndPoint,System.Threading.CancellationToken)">
\r
216 Creates a new connection to an endpoint.
\r
218 <param name="endpoint">The <see cref="T:System.Net.EndPoint"/> to connect to.</param>
\r
219 <param name="cancellationToken">The token to monitor for cancellation requests. The default value is <see cref="P:System.Threading.CancellationToken.None" />.</param>
\r
221 A <see cref="T:System.Threading.Tasks.ValueTask`1" /> that represents the asynchronous connect, yielding the <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext" /> for the new connection when completed.
\r
224 <member name="T:Microsoft.AspNetCore.Connections.IConnectionListener">
\r
226 Defines an interface that represents a listener bound to a specific <see cref="P:Microsoft.AspNetCore.Connections.IConnectionListener.EndPoint"/>.
\r
229 <member name="P:Microsoft.AspNetCore.Connections.IConnectionListener.EndPoint">
\r
231 The endpoint that was bound. This may differ from the requested endpoint, such as when the caller requested that any free port be selected.
\r
234 <member name="M:Microsoft.AspNetCore.Connections.IConnectionListener.AcceptAsync(System.Threading.CancellationToken)">
\r
236 Begins an asynchronous operation to accept an incoming connection.
\r
238 <param name="cancellationToken">The token to monitor for cancellation requests.</param>
\r
239 <returns>A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that completes when a connection is accepted, yielding the <see cref="T:Microsoft.AspNetCore.Connections.ConnectionContext" /> representing the connection.</returns>
\r
241 <member name="M:Microsoft.AspNetCore.Connections.IConnectionListener.UnbindAsync(System.Threading.CancellationToken)">
\r
243 Stops listening for incoming connections.
\r
245 <param name="cancellationToken">The token to monitor for cancellation requests.</param>
\r
246 <returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> that represents the un-bind operation.</returns>
\r
248 <member name="T:Microsoft.AspNetCore.Connections.IConnectionListenerFactory">
\r
250 Defines an interface that provides the mechanisms for binding to various types of <see cref="T:System.Net.EndPoint"/>s.
\r
253 <member name="M:Microsoft.AspNetCore.Connections.IConnectionListenerFactory.BindAsync(System.Net.EndPoint,System.Threading.CancellationToken)">
\r
255 Creates an <see cref="T:Microsoft.AspNetCore.Connections.IConnectionListener"/> bound to the specified <see cref="T:System.Net.EndPoint"/>.
\r
257 <param name="endpoint">The <see cref="T:System.Net.EndPoint" /> to bind to.</param>
\r
258 <param name="cancellationToken">The token to monitor for cancellation requests.</param>
\r
259 <returns>A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that completes when the listener has been bound, yielding a <see cref="T:Microsoft.AspNetCore.Connections.IConnectionListener" /> representing the new listener.</returns>
\r
261 <member name="T:Microsoft.AspNetCore.Connections.UriEndPoint">
\r
263 An <see cref="T:System.Net.EndPoint"/> defined by a <see cref="T:System.Uri"/>.
\r
266 <member name="M:Microsoft.AspNetCore.Connections.UriEndPoint.#ctor(System.Uri)">
\r
268 Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Connections.UriEndPoint"/> class.
\r
270 <param name="uri">The <see cref="T:System.Uri"/> defining the <see cref="T:System.Net.EndPoint"/>.</param>
\r
272 <member name="P:Microsoft.AspNetCore.Connections.UriEndPoint.Uri">
\r
274 The <see cref="T:System.Uri"/> defining the <see cref="T:System.Net.EndPoint"/>.
\r