Nito.Cancellation.xml 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Nito.Cancellation</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Nito.NormalizedCancellationToken">
  8. <summary>
  9. A cancellation token wrapper that may represent multiple linked cancellation tokens. Instances of this type should always be disposed.
  10. </summary>
  11. </member>
  12. <member name="F:Nito.NormalizedCancellationToken._cts">
  13. <summary>
  14. The <see cref="T:System.Threading.CancellationTokenSource"/>, if any. If this is not <c>null</c>, then <see cref="F:Nito.NormalizedCancellationToken._token"/> is <c>_cts.Token</c>.
  15. </summary>
  16. </member>
  17. <member name="F:Nito.NormalizedCancellationToken._token">
  18. <summary>
  19. The <see cref="P:Nito.NormalizedCancellationToken.Token"/>. If <see cref="F:Nito.NormalizedCancellationToken._cts"/> is not <c>null</c>, then this is <c>_cts.Token</c>.
  20. </summary>
  21. </member>
  22. <member name="M:Nito.NormalizedCancellationToken.#ctor">
  23. <summary>
  24. Creates a normalized cancellation token that can never be canceled.
  25. </summary>
  26. </member>
  27. <member name="M:Nito.NormalizedCancellationToken.#ctor(System.Threading.CancellationTokenSource)">
  28. <summary>
  29. Creates a normalized cancellation token from a <see cref="T:System.Threading.CancellationTokenSource"/>. <see cref="P:Nito.NormalizedCancellationToken.Token"/> is set to the <see cref="P:System.Threading.CancellationTokenSource.Token"/> property of <paramref name="cts"/>.
  30. </summary>
  31. <param name="cts">The source for this token. May be <c>null</c> to create a normalized cancellation token that can never be canceled.</param>
  32. </member>
  33. <member name="M:Nito.NormalizedCancellationToken.#ctor(System.Threading.CancellationToken)">
  34. <summary>
  35. Creates a normalized cancellation token from a <see cref="T:System.Threading.CancellationToken"/>. <see cref="P:Nito.NormalizedCancellationToken.Token"/> is set to <paramref name="token"/>.
  36. </summary>
  37. <param name="token">The source for this token.</param>
  38. </member>
  39. <member name="M:Nito.NormalizedCancellationToken.Dispose(System.Object)">
  40. <summary>
  41. Releases any resources used by this normalized cancellation token.
  42. </summary>
  43. </member>
  44. <member name="P:Nito.NormalizedCancellationToken.Token">
  45. <summary>
  46. Gets the <see cref="T:System.Threading.CancellationToken"/> for this normalized cancellation token.
  47. </summary>
  48. </member>
  49. <member name="M:Nito.NormalizedCancellationToken.Timeout(System.TimeSpan)">
  50. <summary>
  51. Creates a cancellation token that is canceled after the due time.
  52. </summary>
  53. <param name="dueTime">The due time after which to cancel the token.</param>
  54. <returns>A cancellation token that is canceled after the due time.</returns>
  55. </member>
  56. <member name="M:Nito.NormalizedCancellationToken.Timeout(System.Int32)">
  57. <summary>
  58. Creates a cancellation token that is canceled after the due time.
  59. </summary>
  60. <param name="dueTime">The due time after which to cancel the token.</param>
  61. <returns>A cancellation token that is canceled after the due time.</returns>
  62. </member>
  63. <member name="M:Nito.NormalizedCancellationToken.Normalize(System.Threading.CancellationToken[])">
  64. <summary>
  65. Reduces a set of cancellation tokens by removing any cancellation tokens that cannot be canceled. If any tokens are already canceled, the returned token will be canceled.
  66. </summary>
  67. <param name="cancellationTokens">The cancellation tokens to reduce. May not be <c>null</c>.</param>
  68. </member>
  69. <member name="M:Nito.NormalizedCancellationToken.Normalize(System.Collections.Generic.IEnumerable{System.Threading.CancellationToken})">
  70. <summary>
  71. Reduces a set of cancellation tokens by removing any cancellation tokens that cannot be canceled. If any tokens are already canceled, the returned token will be canceled.
  72. </summary>
  73. <param name="cancellationTokens">The cancellation tokens to reduce. May not be <c>null</c>.</param>
  74. </member>
  75. </members>
  76. </doc>