Microsoft.Bcl.AsyncInterfaces.xml 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Bcl.AsyncInterfaces</name>
  5. </assembly>
  6. <members>
  7. <member name="T:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1">
  8. <summary>Provides the core logic for implementing a manual-reset <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource"/> or <see cref="T:System.Threading.Tasks.Sources.IValueTaskSource`1"/>.</summary>
  9. <typeparam name="TResult"></typeparam>
  10. </member>
  11. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation">
  12. <summary>
  13. The callback to invoke when the operation completes if <see cref="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)"/> was called before the operation completed,
  14. or <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCoreShared.s_sentinel"/> if the operation completed before a callback was supplied,
  15. or null if a callback hasn't yet been provided and the operation hasn't yet completed.
  16. </summary>
  17. </member>
  18. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuationState">
  19. <summary>State to pass to <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._continuation"/>.</summary>
  20. </member>
  21. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext">
  22. <summary><see cref="T:System.Threading.ExecutionContext"/> to flow to the callback, or null if no flowing is required.</summary>
  23. </member>
  24. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._capturedContext">
  25. <summary>
  26. A "captured" <see cref="T:System.Threading.SynchronizationContext"/> or <see cref="T:System.Threading.Tasks.TaskScheduler"/> with which to invoke the callback,
  27. or null if no special context is required.
  28. </summary>
  29. </member>
  30. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._completed">
  31. <summary>Whether the current operation has completed.</summary>
  32. </member>
  33. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._result">
  34. <summary>The result with which the operation succeeded, or the default value if it hasn't yet completed or failed.</summary>
  35. </member>
  36. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._error">
  37. <summary>The exception with which the operation failed, or null if it hasn't yet completed or completed successfully.</summary>
  38. </member>
  39. <member name="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._version">
  40. <summary>The current version of this value, used to help prevent misuse.</summary>
  41. </member>
  42. <member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.RunContinuationsAsynchronously">
  43. <summary>Gets or sets whether to force continuations to run asynchronously.</summary>
  44. <remarks>Continuations may run asynchronously if this is false, but they'll never run synchronously if this is true.</remarks>
  45. </member>
  46. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Reset">
  47. <summary>Resets to prepare for the next operation.</summary>
  48. </member>
  49. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetResult(`0)">
  50. <summary>Completes with a successful result.</summary>
  51. <param name="result">The result.</param>
  52. </member>
  53. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SetException(System.Exception)">
  54. <summary>Complets with an error.</summary>
  55. <param name="error"></param>
  56. </member>
  57. <member name="P:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.Version">
  58. <summary>Gets the operation version.</summary>
  59. </member>
  60. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetStatus(System.Int16)">
  61. <summary>Gets the status of the operation.</summary>
  62. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  63. </member>
  64. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.GetResult(System.Int16)">
  65. <summary>Gets the result of the operation.</summary>
  66. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  67. </member>
  68. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.OnCompleted(System.Action{System.Object},System.Object,System.Int16,System.Threading.Tasks.Sources.ValueTaskSourceOnCompletedFlags)">
  69. <summary>Schedules the continuation action for this operation.</summary>
  70. <param name="continuation">The continuation to invoke when the operation has completed.</param>
  71. <param name="state">The state object to pass to <paramref name="continuation"/> when it's invoked.</param>
  72. <param name="token">Opaque value that was provided to the <see cref="T:System.Threading.Tasks.ValueTask"/>'s constructor.</param>
  73. <param name="flags">The flags describing the behavior of the continuation.</param>
  74. </member>
  75. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.ValidateToken(System.Int16)">
  76. <summary>Ensures that the specified token matches the current version.</summary>
  77. <param name="token">The token supplied by <see cref="T:System.Threading.Tasks.ValueTask"/>.</param>
  78. </member>
  79. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.SignalCompletion">
  80. <summary>Signals that the operation has completed. Invoked after the result or error has been set.</summary>
  81. </member>
  82. <member name="M:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1.InvokeContinuation">
  83. <summary>
  84. Invokes the continuation with the appropriate captured context / scheduler.
  85. This assumes that if <see cref="F:System.Threading.Tasks.Sources.ManualResetValueTaskSourceCore`1._executionContext"/> is not null we're already
  86. running within that <see cref="T:System.Threading.ExecutionContext"/>.
  87. </summary>
  88. </member>
  89. <member name="T:System.Threading.Tasks.TaskAsyncEnumerableExtensions">
  90. <summary>Provides a set of static methods for configuring <see cref="T:System.Threading.Tasks.Task"/>-related behaviors on asynchronous enumerables and disposables.</summary>
  91. </member>
  92. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait(System.IAsyncDisposable,System.Boolean)">
  93. <summary>Configures how awaits on the tasks returned from an async disposable will be performed.</summary>
  94. <param name="source">The source async disposable.</param>
  95. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  96. <returns>The configured async disposable.</returns>
  97. </member>
  98. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.ConfigureAwait``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Boolean)">
  99. <summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
  100. <typeparam name="T">The type of the objects being iterated.</typeparam>
  101. <param name="source">The source enumerable being iterated.</param>
  102. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  103. <returns>The configured enumerable.</returns>
  104. </member>
  105. <member name="M:System.Threading.Tasks.TaskAsyncEnumerableExtensions.WithCancellation``1(System.Collections.Generic.IAsyncEnumerable{``0},System.Threading.CancellationToken)">
  106. <summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
  107. <typeparam name="T">The type of the objects being iterated.</typeparam>
  108. <param name="source">The source enumerable being iterated.</param>
  109. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
  110. <returns>The configured enumerable.</returns>
  111. </member>
  112. <member name="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder">
  113. <summary>Represents a builder for asynchronous iterators.</summary>
  114. </member>
  115. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Create">
  116. <summary>Creates an instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder"/> struct.</summary>
  117. <returns>The initialized instance.</returns>
  118. </member>
  119. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.MoveNext``1(``0@)">
  120. <summary>Invokes <see cref="M:System.Runtime.CompilerServices.IAsyncStateMachine.MoveNext"/> on the state machine while guarding the <see cref="T:System.Threading.ExecutionContext"/>.</summary>
  121. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  122. <param name="stateMachine">The state machine instance, passed by reference.</param>
  123. </member>
  124. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitOnCompleted``2(``0@,``1@)">
  125. <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  126. <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  127. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  128. <param name="awaiter">The awaiter.</param>
  129. <param name="stateMachine">The state machine.</param>
  130. </member>
  131. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.AwaitUnsafeOnCompleted``2(``0@,``1@)">
  132. <summary>Schedules the state machine to proceed to the next action when the specified awaiter completes.</summary>
  133. <typeparam name="TAwaiter">The type of the awaiter.</typeparam>
  134. <typeparam name="TStateMachine">The type of the state machine.</typeparam>
  135. <param name="awaiter">The awaiter.</param>
  136. <param name="stateMachine">The state machine.</param>
  137. </member>
  138. <member name="M:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.Complete">
  139. <summary>Marks iteration as being completed, whether successfully or otherwise.</summary>
  140. </member>
  141. <member name="P:System.Runtime.CompilerServices.AsyncIteratorMethodBuilder.ObjectIdForDebugger">
  142. <summary>Gets an object that may be used to uniquely identify this builder to the debugger.</summary>
  143. </member>
  144. <member name="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute">
  145. <summary>Indicates whether a method is an asynchronous iterator.</summary>
  146. </member>
  147. <member name="M:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute.#ctor(System.Type)">
  148. <summary>Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.AsyncIteratorStateMachineAttribute"/> class.</summary>
  149. <param name="stateMachineType">The type object for the underlying state machine type that's used to implement a state machine method.</param>
  150. </member>
  151. <member name="T:System.Runtime.CompilerServices.ConfiguredAsyncDisposable">
  152. <summary>Provides a type that can be used to configure how awaits on an <see cref="T:System.IAsyncDisposable"/> are performed.</summary>
  153. </member>
  154. <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1">
  155. <summary>Provides an awaitable async enumerable that enables cancelable iteration and configured awaits.</summary>
  156. </member>
  157. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)">
  158. <summary>Configures how awaits on the tasks returned from an async iteration will be performed.</summary>
  159. <param name="continueOnCapturedContext">Whether to capture and marshal back to the current context.</param>
  160. <returns>The configured enumerable.</returns>
  161. <remarks>This will replace any previous value set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.ConfigureAwait(System.Boolean)"/> for this iteration.</remarks>
  162. </member>
  163. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)">
  164. <summary>Sets the <see cref="T:System.Threading.CancellationToken"/> to be passed to <see cref="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)"/> when iterating.</summary>
  165. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to use.</param>
  166. <returns>The configured enumerable.</returns>
  167. <remarks>This will replace any previous <see cref="T:System.Threading.CancellationToken"/> set by <see cref="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.WithCancellation(System.Threading.CancellationToken)"/> for this iteration.</remarks>
  168. </member>
  169. <member name="T:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator">
  170. <summary>Provides an awaitable async enumerator that enables cancelable iteration and configured awaits.</summary>
  171. </member>
  172. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.MoveNextAsync">
  173. <summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
  174. <returns>
  175. A <see cref="T:System.Runtime.CompilerServices.ConfiguredValueTaskAwaitable`1"/> that will complete with a result of <c>true</c>
  176. if the enumerator was successfully advanced to the next element, or <c>false</c> if the enumerator has
  177. passed the end of the collection.
  178. </returns>
  179. </member>
  180. <member name="P:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.Current">
  181. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  182. </member>
  183. <member name="M:System.Runtime.CompilerServices.ConfiguredCancelableAsyncEnumerable`1.Enumerator.DisposeAsync">
  184. <summary>
  185. Performs application-defined tasks associated with freeing, releasing, or
  186. resetting unmanaged resources asynchronously.
  187. </summary>
  188. </member>
  189. <member name="T:System.Collections.Generic.IAsyncEnumerable`1">
  190. <summary>Exposes an enumerator that provides asynchronous iteration over values of a specified type.</summary>
  191. <typeparam name="T">The type of values to enumerate.</typeparam>
  192. </member>
  193. <member name="M:System.Collections.Generic.IAsyncEnumerable`1.GetAsyncEnumerator(System.Threading.CancellationToken)">
  194. <summary>Returns an enumerator that iterates asynchronously through the collection.</summary>
  195. <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that may be used to cancel the asynchronous iteration.</param>
  196. <returns>An enumerator that can be used to iterate asynchronously through the collection.</returns>
  197. </member>
  198. <member name="T:System.Collections.Generic.IAsyncEnumerator`1">
  199. <summary>Supports a simple asynchronous iteration over a generic collection.</summary>
  200. <typeparam name="T">The type of objects to enumerate.</typeparam>
  201. </member>
  202. <member name="M:System.Collections.Generic.IAsyncEnumerator`1.MoveNextAsync">
  203. <summary>Advances the enumerator asynchronously to the next element of the collection.</summary>
  204. <returns>
  205. A <see cref="T:System.Threading.Tasks.ValueTask`1"/> that will complete with a result of <c>true</c> if the enumerator
  206. was successfully advanced to the next element, or <c>false</c> if the enumerator has passed the end
  207. of the collection.
  208. </returns>
  209. </member>
  210. <member name="P:System.Collections.Generic.IAsyncEnumerator`1.Current">
  211. <summary>Gets the element in the collection at the current position of the enumerator.</summary>
  212. </member>
  213. <member name="T:System.IAsyncDisposable">
  214. <summary>Provides a mechanism for releasing unmanaged resources asynchronously.</summary>
  215. </member>
  216. <member name="M:System.IAsyncDisposable.DisposeAsync">
  217. <summary>
  218. Performs application-defined tasks associated with freeing, releasing, or
  219. resetting unmanaged resources asynchronously.
  220. </summary>
  221. </member>
  222. </members>
  223. </doc>