129540b56668a110411d66dc67398d714a94b19f
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Connections.Abstractions</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.Extensions.Internal.ActivatorUtilities">\r
8             <summary>\r
9             Helper code for the various activator services.\r
10             </summary>\r
11         </member>\r
12         <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance(System.IServiceProvider,System.Type,System.Object[])">\r
13             <summary>\r
14             Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.\r
15             </summary>\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
20         </member>\r
21         <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])">\r
22             <summary>\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
25             </summary>\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
29             </param>\r
30             <returns>\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
33             </returns>\r
34         </member>\r
35         <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])">\r
36             <summary>\r
37             Instantiate a type with constructor arguments provided directly and/or from an <see cref="T:System.IServiceProvider"/>.\r
38             </summary>\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
43         </member>\r
44         <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)">\r
45             <summary>\r
46             Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.\r
47             </summary>\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
51         </member>\r
52         <member name="M:Microsoft.Extensions.Internal.ActivatorUtilities.GetServiceOrCreateInstance(System.IServiceProvider,System.Type)">\r
53             <summary>\r
54             Retrieve an instance of the given type from the service provider. If one is not found then instantiate it directly.\r
55             </summary>\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
59         </member>\r
60         <member name="T:Microsoft.Extensions.Internal.ActivatorUtilitiesConstructorAttribute">\r
61             <summary>\r
62             Marks the constructor to be used when activating type using <see cref="T:Microsoft.Extensions.Internal.ActivatorUtilities"/>.\r
63             </summary>\r
64         </member>\r
65         <member name="T:Microsoft.Extensions.Internal.ObjectFactory">\r
66             <summary>\r
67             The result of <see cref="M:Microsoft.Extensions.Internal.ActivatorUtilities.CreateFactory(System.Type,System.Type[])"/>.\r
68             </summary>\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
72         </member>\r
73         <member name="T:Microsoft.AspNetCore.Connections.ConnectionContext">\r
74             <summary>\r
75             Encapsulates all information about an individual connection.\r
76             </summary>\r
77         </member>\r
78         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.ConnectionId">\r
79             <summary>\r
80             Gets or sets a unique identifier to represent this connection in trace logs.\r
81             </summary>\r
82         </member>\r
83         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Features">\r
84             <summary>\r
85             Gets the collection of features provided by the server and middleware available on this connection.\r
86             </summary>\r
87         </member>\r
88         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Items">\r
89             <summary>\r
90             Gets or sets a key/value collection that can be used to share data within the scope of this connection.\r
91             </summary>\r
92         </member>\r
93         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.Transport">\r
94             <summary>\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
96             </summary>\r
97         </member>\r
98         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.ConnectionClosed">\r
99             <summary>\r
100             Triggered when the client connection is closed.\r
101             </summary>\r
102         </member>\r
103         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.LocalEndPoint">\r
104             <summary>\r
105             Gets or sets the local endpoint for this connection.\r
106             </summary>\r
107         </member>\r
108         <member name="P:Microsoft.AspNetCore.Connections.ConnectionContext.RemoteEndPoint">\r
109             <summary>\r
110             Gets or sets the remote endpoint for this connection.\r
111             </summary>\r
112         </member>\r
113         <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.Abort(Microsoft.AspNetCore.Connections.ConnectionAbortedException)">\r
114             <summary>\r
115             Aborts the underlying connection.\r
116             </summary>\r
117             <param name="abortReason">An optional <see cref="T:Microsoft.AspNetCore.Connections.ConnectionAbortedException"/> describing the reason the connection is being terminated.</param>\r
118         </member>\r
119         <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.Abort">\r
120             <summary>\r
121             Aborts the underlying connection.\r
122             </summary>\r
123         </member>\r
124         <member name="M:Microsoft.AspNetCore.Connections.ConnectionContext.DisposeAsync">\r
125             <summary>\r
126             Releases resources for the underlying connection.\r
127             </summary>\r
128             <returns>A <see cref="T:System.Threading.Tasks.ValueTask"/> that completes when resources have been released.</returns>\r
129         </member>\r
130         <member name="T:Microsoft.AspNetCore.Connections.ConnectionDelegate">\r
131             <summary>\r
132             A function that can process a connection.\r
133             </summary>\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
136         </member>\r
137         <member name="T:Microsoft.AspNetCore.Connections.ConnectionHandler">\r
138             <summary>\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
140             </summary>\r
141         </member>\r
142         <member name="M:Microsoft.AspNetCore.Connections.ConnectionHandler.OnConnectedAsync(Microsoft.AspNetCore.Connections.ConnectionContext)">\r
143             <summary>\r
144             Called when a new connection is accepted to the endpoint\r
145             </summary>\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
148         </member>\r
149         <member name="M:Microsoft.AspNetCore.Connections.DefaultConnectionContext.#ctor(System.String)">\r
150             <summary>\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
153             </summary>\r
154             <param name="id"></param>\r
155         </member>\r
156         <member name="T:Microsoft.AspNetCore.Connections.Features.IConnectionCompleteFeature">\r
157             <summary>\r
158             Represents the completion action for a connection.\r
159             </summary>\r
160         </member>\r
161         <member name="M:Microsoft.AspNetCore.Connections.Features.IConnectionCompleteFeature.OnCompleted(System.Func{System.Object,System.Threading.Tasks.Task},System.Object)">\r
162             <summary>\r
163             Registers a callback to be invoked after a connection has fully completed processing. This is\r
164             intended for resource cleanup.\r
165             </summary>\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
168         </member>\r
169         <member name="T:Microsoft.AspNetCore.Connections.Features.IConnectionInherentKeepAliveFeature">\r
170             <summary>\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
173             </summary>\r
174             <remarks>\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
179             </remarks>\r
180         </member>\r
181         <member name="T:Microsoft.AspNetCore.Connections.FileHandleType">\r
182             <summary>\r
183             Enumerates the <see cref="T:Microsoft.AspNetCore.Connections.FileHandleEndPoint"/> types.\r
184             </summary>\r
185         </member>\r
186         <member name="T:Microsoft.AspNetCore.Connections.IConnectionBuilder">\r
187             <summary>\r
188             Defines an interface that provides the mechanisms to configure a connection pipeline.\r
189             </summary>\r
190         </member>\r
191         <member name="P:Microsoft.AspNetCore.Connections.IConnectionBuilder.ApplicationServices">\r
192             <summary>\r
193             Gets the <see cref="T:System.IServiceProvider"/> that provides access to the application's service container.\r
194             </summary>\r
195         </member>\r
196         <member name="M:Microsoft.AspNetCore.Connections.IConnectionBuilder.Use(System.Func{Microsoft.AspNetCore.Connections.ConnectionDelegate,Microsoft.AspNetCore.Connections.ConnectionDelegate})">\r
197             <summary>\r
198             Adds a middleware delegate to the application's connection pipeline.\r
199             </summary>\r
200             <param name="middleware">The middleware delegate.</param>\r
201             <returns>The <see cref="T:Microsoft.AspNetCore.Connections.IConnectionBuilder"/>.</returns>\r
202         </member>\r
203         <member name="M:Microsoft.AspNetCore.Connections.IConnectionBuilder.Build">\r
204             <summary>\r
205             Builds the delegate used by this application to process connections.\r
206             </summary>\r
207             <returns>The connection handling delegate.</returns>\r
208         </member>\r
209         <member name="T:Microsoft.AspNetCore.Connections.IConnectionFactory">\r
210             <summary>\r
211             A factory abstraction for creating connections to an endpoint.\r
212             </summary>\r
213         </member>\r
214         <member name="M:Microsoft.AspNetCore.Connections.IConnectionFactory.ConnectAsync(System.Net.EndPoint,System.Threading.CancellationToken)">\r
215             <summary>\r
216             Creates a new connection to an endpoint.\r
217             </summary>\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
220             <returns>\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
222             </returns>\r
223         </member>\r
224         <member name="T:Microsoft.AspNetCore.Connections.IConnectionListener">\r
225             <summary>\r
226             Defines an interface that represents a listener bound to a specific <see cref="P:Microsoft.AspNetCore.Connections.IConnectionListener.EndPoint"/>.\r
227             </summary>\r
228         </member>\r
229         <member name="P:Microsoft.AspNetCore.Connections.IConnectionListener.EndPoint">\r
230             <summary>\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
232             </summary>\r
233         </member>\r
234         <member name="M:Microsoft.AspNetCore.Connections.IConnectionListener.AcceptAsync(System.Threading.CancellationToken)">\r
235             <summary>\r
236             Begins an asynchronous operation to accept an incoming connection.\r
237             </summary>\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
240         </member>\r
241         <member name="M:Microsoft.AspNetCore.Connections.IConnectionListener.UnbindAsync(System.Threading.CancellationToken)">\r
242             <summary>\r
243             Stops listening for incoming connections.\r
244             </summary>\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
247         </member>\r
248         <member name="T:Microsoft.AspNetCore.Connections.IConnectionListenerFactory">\r
249             <summary>\r
250             Defines an interface that provides the mechanisms for binding to various types of <see cref="T:System.Net.EndPoint"/>s.\r
251             </summary>\r
252         </member>\r
253         <member name="M:Microsoft.AspNetCore.Connections.IConnectionListenerFactory.BindAsync(System.Net.EndPoint,System.Threading.CancellationToken)">\r
254             <summary>\r
255             Creates an <see cref="T:Microsoft.AspNetCore.Connections.IConnectionListener"/> bound to the specified <see cref="T:System.Net.EndPoint"/>.\r
256             </summary>\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
260         </member>\r
261         <member name="T:Microsoft.AspNetCore.Connections.UriEndPoint">\r
262             <summary>\r
263             An <see cref="T:System.Net.EndPoint"/> defined by a <see cref="T:System.Uri"/>.\r
264             </summary>\r
265         </member>\r
266         <member name="M:Microsoft.AspNetCore.Connections.UriEndPoint.#ctor(System.Uri)">\r
267             <summary>\r
268             Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.Connections.UriEndPoint"/> class.\r
269             </summary>\r
270             <param name="uri">The <see cref="T:System.Uri"/> defining the <see cref="T:System.Net.EndPoint"/>.</param>\r
271         </member>\r
272         <member name="P:Microsoft.AspNetCore.Connections.UriEndPoint.Uri">\r
273             <summary>\r
274             The <see cref="T:System.Uri"/> defining the <see cref="T:System.Net.EndPoint"/>.\r
275             </summary>\r
276         </member>\r
277     </members>\r
278 </doc>\r