3daa7fa81d5d89b56beafe3d24ec8359458818b0
[platform/core/dotnet/build-tools.git] /
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Microsoft.AspNetCore.Server.Kestrel.Transport.Quic</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.Internal.ISystemClock">\r
8             <summary>\r
9             Abstracts the system clock to facilitate testing.\r
10             </summary>\r
11         </member>\r
12         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.Internal.ISystemClock.UtcNow">\r
13             <summary>\r
14             Retrieves the current system time in UTC.\r
15             </summary>\r
16         </member>\r
17         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.Internal.QuicConnectionListener">\r
18             <summary>\r
19             Listens for new Quic Connections.\r
20             </summary>\r
21         </member>\r
22         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportFactory">\r
23             <summary>\r
24             A factory for QUIC based connections.\r
25             </summary>\r
26         </member>\r
27         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportFactory.BindAsync(System.Net.EndPoint,Microsoft.AspNetCore.Http.Features.IFeatureCollection,System.Threading.CancellationToken)">\r
28             <summary>\r
29             Binds an endpoint to be used for QUIC connections.\r
30             </summary>\r
31             <param name="endpoint">The endpoint to bind to.</param>\r
32             <param name="features">Additional features to be used to create the listener.</param>\r
33             <param name="cancellationToken">To cancel the </param>\r
34             <returns>A </returns>\r
35         </member>\r
36         <member name="T:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions">\r
37             <summary>\r
38             Options for Quic based connections.\r
39             </summary>\r
40         </member>\r
41         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.MaxBidirectionalStreamCount">\r
42             <summary>\r
43             The maximum number of concurrent bi-directional streams per connection.\r
44             </summary>\r
45         </member>\r
46         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.MaxUnidirectionalStreamCount">\r
47             <summary>\r
48             The maximum number of concurrent inbound uni-directional streams per connection.\r
49             </summary>\r
50         </member>\r
51         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.IdleTimeout">\r
52             <summary>\r
53             Sets the idle timeout for connections and streams.\r
54             </summary>\r
55         </member>\r
56         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.MaxReadBufferSize">\r
57             <summary>\r
58             The maximum read size.\r
59             </summary>\r
60         </member>\r
61         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.MaxWriteBufferSize">\r
62             <summary>\r
63             The maximum write size.\r
64             </summary>\r
65         </member>\r
66         <member name="P:Microsoft.AspNetCore.Server.Kestrel.Transport.Quic.QuicTransportOptions.Backlog">\r
67             <summary>\r
68             The maximum length of the pending connection queue.\r
69             </summary>\r
70         </member>\r
71         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure.StringUtilities.WidenFourAsciiBytesToUtf16AndCompareToChars(System.Char@,System.UInt32)">\r
72             <summary>\r
73             Given a DWORD which represents a buffer of 4 bytes, widens the buffer into 4 WORDs and\r
74             compares them to the WORD buffer with machine endianness.\r
75             </summary>\r
76         </member>\r
77         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure.StringUtilities.WidenTwoAsciiBytesToUtf16AndCompareToChars(System.Char@,System.UInt16)">\r
78             <summary>\r
79             Given a WORD which represents a buffer of 2 bytes, widens the buffer into 2 WORDs and\r
80             compares them to the WORD buffer with machine endianness.\r
81             </summary>\r
82         </member>\r
83         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure.StringUtilities.AllBytesInUInt32AreAscii(System.UInt32)">\r
84             <summary>\r
85             Returns <see langword="true"/> iff all bytes in <paramref name="value"/> are ASCII.\r
86             </summary>\r
87         </member>\r
88         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure.StringUtilities.AllBytesInUInt16AreAscii(System.UInt16)">\r
89             <summary>\r
90             Returns <see langword="true"/> iff all bytes in <paramref name="value"/> are ASCII.\r
91             </summary>\r
92         </member>\r
93         <member name="M:Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure.StringUtilities.ConcatAsHexSuffix(System.String,System.Char,System.UInt32)">\r
94             <summary>\r
95             A faster version of String.Concat(<paramref name="str"/>, <paramref name="separator"/>, <paramref name="number"/>.ToString("X8"))\r
96             </summary>\r
97             <param name="str"></param>\r
98             <param name="separator"></param>\r
99             <param name="number"></param>\r
100             <returns></returns>\r
101         </member>\r
102         <member name="T:Microsoft.AspNetCore.Hosting.WebHostBuilderQuicExtensions">\r
103             <summary>\r
104             Quic <see cref="T:Microsoft.AspNetCore.Hosting.IWebHostBuilder"/> extensions.\r
105             </summary>\r
106         </member>\r
107         <member name="T:System.Buffers.DiagnosticMemoryPool">\r
108             <summary>\r
109             Used to allocate and distribute re-usable blocks of memory.\r
110             </summary>\r
111         </member>\r
112         <member name="F:System.Buffers.DiagnosticMemoryPool.AnySize">\r
113             <summary>\r
114             This default value passed in to Rent to use the default value for the pool.\r
115             </summary>\r
116         </member>\r
117         <member name="T:System.Buffers.DiagnosticPoolBlock">\r
118             <summary>\r
119             Block tracking object used by the byte buffer memory pool. A slab is a large allocation which is divided into smaller blocks. The\r
120             individual blocks are then treated as independent array segments.\r
121             </summary>\r
122         </member>\r
123         <member name="F:System.Buffers.DiagnosticPoolBlock._pool">\r
124             <summary>\r
125             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
126             </summary>\r
127         </member>\r
128         <member name="M:System.Buffers.DiagnosticPoolBlock.#ctor(System.Buffers.DiagnosticMemoryPool,System.Buffers.IMemoryOwner{System.Byte})">\r
129             <summary>\r
130             This object cannot be instantiated outside of the static Create method\r
131             </summary>\r
132         </member>\r
133         <member name="T:System.Buffers.MemoryPoolBlock">\r
134             <summary>\r
135             Wraps an array allocated in the pinned object heap in a reusable block of managed memory\r
136             </summary>\r
137         </member>\r
138         <member name="P:System.Buffers.MemoryPoolBlock.Pool">\r
139             <summary>\r
140             Back-reference to the memory pool which this block was allocated from. It may only be returned to this pool.\r
141             </summary>\r
142         </member>\r
143         <member name="T:System.Buffers.PinnedBlockMemoryPool">\r
144             <summary>\r
145             Used to allocate and distribute re-usable blocks of memory.\r
146             </summary>\r
147         </member>\r
148         <member name="F:System.Buffers.PinnedBlockMemoryPool._blockSize">\r
149             <summary>\r
150             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
151             </summary>\r
152         </member>\r
153         <member name="P:System.Buffers.PinnedBlockMemoryPool.MaxBufferSize">\r
154             <summary>\r
155             Max allocation block size for pooled blocks,\r
156             larger values can be leased but they will be disposed after use rather than returned to the pool.\r
157             </summary>\r
158         </member>\r
159         <member name="P:System.Buffers.PinnedBlockMemoryPool.BlockSize">\r
160             <summary>\r
161             The size of a block. 4096 is chosen because most operating systems use 4k pages.\r
162             </summary>\r
163         </member>\r
164         <member name="F:System.Buffers.PinnedBlockMemoryPool._blocks">\r
165             <summary>\r
166             Thread-safe collection of blocks which are currently in the pool. A slab will pre-allocate all of the block tracking objects\r
167             and add them to this collection. When memory is requested it is taken from here first, and when it is returned it is re-added.\r
168             </summary>\r
169         </member>\r
170         <member name="F:System.Buffers.PinnedBlockMemoryPool._isDisposed">\r
171             <summary>\r
172             This is part of implementing the IDisposable pattern.\r
173             </summary>\r
174         </member>\r
175         <member name="F:System.Buffers.PinnedBlockMemoryPool.AnySize">\r
176             <summary>\r
177             This default value passed in to Rent to use the default value for the pool.\r
178             </summary>\r
179         </member>\r
180         <member name="M:System.Buffers.PinnedBlockMemoryPool.Return(System.Buffers.MemoryPoolBlock)">\r
181             <summary>\r
182             Called to return a block to the pool. Once Return has been called the memory no longer belongs to the caller, and\r
183             Very Bad Things will happen if the memory is read of modified subsequently. If a caller fails to call Return and the\r
184             block tracking object is garbage collected, the block tracking object's finalizer will automatically re-create and return\r
185             a new tracking object into the pool. This will only happen if there is a bug in the server, however it is necessary to avoid\r
186             leaving "dead zones" in the slab due to lost block tracking objects.\r
187             </summary>\r
188             <param name="block">The block to return. It must have been acquired by calling Lease on the same memory pool instance.</param>\r
189         </member>\r
190         <member name="T:System.Threading.Tasks.TaskToApm">\r
191             <summary>\r
192             Provides support for efficiently using Tasks to implement the APM (Begin/End) pattern.\r
193             </summary>\r
194         </member>\r
195         <member name="M:System.Threading.Tasks.TaskToApm.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)">\r
196             <summary>\r
197             Marshals the Task as an IAsyncResult, using the supplied callback and state\r
198             to implement the APM pattern.\r
199             </summary>\r
200             <param name="task">The Task to be marshaled.</param>\r
201             <param name="callback">The callback to be invoked upon completion.</param>\r
202             <param name="state">The state to be stored in the IAsyncResult.</param>\r
203             <returns>An IAsyncResult to represent the task's asynchronous operation.</returns>\r
204         </member>\r
205         <member name="M:System.Threading.Tasks.TaskToApm.End(System.IAsyncResult)">\r
206             <summary>Processes an IAsyncResult returned by Begin.</summary>\r
207             <param name="asyncResult">The IAsyncResult to unwrap.</param>\r
208         </member>\r
209         <member name="M:System.Threading.Tasks.TaskToApm.End``1(System.IAsyncResult)">\r
210             <summary>Processes an IAsyncResult returned by Begin.</summary>\r
211             <param name="asyncResult">The IAsyncResult to unwrap.</param>\r
212         </member>\r
213         <member name="T:System.Threading.Tasks.TaskToApm.TaskAsyncResult">\r
214             <summary>Provides a simple IAsyncResult that wraps a Task.</summary>\r
215             <remarks>\r
216             We could use the Task as the IAsyncResult if the Task's AsyncState is the same as the object state,\r
217             but that's very rare, in particular in a situation where someone cares about allocation, and always\r
218             using TaskAsyncResult simplifies things and enables additional optimizations.\r
219             </remarks>\r
220         </member>\r
221         <member name="F:System.Threading.Tasks.TaskToApm.TaskAsyncResult._task">\r
222             <summary>The wrapped Task.</summary>\r
223         </member>\r
224         <member name="F:System.Threading.Tasks.TaskToApm.TaskAsyncResult._callback">\r
225             <summary>Callback to invoke when the wrapped task completes.</summary>\r
226         </member>\r
227         <member name="M:System.Threading.Tasks.TaskToApm.TaskAsyncResult.#ctor(System.Threading.Tasks.Task,System.Object,System.AsyncCallback)">\r
228             <summary>Initializes the IAsyncResult with the Task to wrap and the associated object state.</summary>\r
229             <param name="task">The Task to wrap.</param>\r
230             <param name="state">The new AsyncState value.</param>\r
231             <param name="callback">Callback to invoke when the wrapped task completes.</param>\r
232         </member>\r
233         <member name="M:System.Threading.Tasks.TaskToApm.TaskAsyncResult.InvokeCallback">\r
234             <summary>Invokes the callback.</summary>\r
235         </member>\r
236         <member name="P:System.Threading.Tasks.TaskToApm.TaskAsyncResult.AsyncState">\r
237             <summary>Gets a user-defined object that qualifies or contains information about an asynchronous operation.</summary>\r
238         </member>\r
239         <member name="P:System.Threading.Tasks.TaskToApm.TaskAsyncResult.CompletedSynchronously">\r
240             <summary>Gets a value that indicates whether the asynchronous operation completed synchronously.</summary>\r
241             <remarks>This is set lazily based on whether the <see cref="F:System.Threading.Tasks.TaskToApm.TaskAsyncResult._task"/> has completed by the time this object is created.</remarks>\r
242         </member>\r
243         <member name="P:System.Threading.Tasks.TaskToApm.TaskAsyncResult.IsCompleted">\r
244             <summary>Gets a value that indicates whether the asynchronous operation has completed.</summary>\r
245         </member>\r
246         <member name="P:System.Threading.Tasks.TaskToApm.TaskAsyncResult.AsyncWaitHandle">\r
247             <summary>Gets a <see cref="T:System.Threading.WaitHandle"/> that is used to wait for an asynchronous operation to complete.</summary>\r
248         </member>\r
249     </members>\r
250 </doc>\r