ConcurrentCollections.xml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ConcurrentCollections</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ConcurrentCollections.ConcurrentHashSet`1">
  8. <summary>
  9. Represents a thread-safe hash-based unique collection.
  10. </summary>
  11. <typeparam name="T">The type of the items in the collection.</typeparam>
  12. <remarks>
  13. All public members of <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> are thread-safe and may be used
  14. concurrently from multiple threads.
  15. </remarks>
  16. </member>
  17. <member name="P:ConcurrentCollections.ConcurrentHashSet`1.Count">
  18. <summary>
  19. Gets the number of items contained in the <see
  20. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.
  21. </summary>
  22. <value>The number of items contained in the <see
  23. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</value>
  24. <remarks>Count has snapshot semantics and represents the number of items in the <see
  25. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  26. at the moment when Count was accessed.</remarks>
  27. </member>
  28. <member name="P:ConcurrentCollections.ConcurrentHashSet`1.IsEmpty">
  29. <summary>
  30. Gets a value that indicates whether the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> is empty.
  31. </summary>
  32. <value>true if the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> is empty; otherwise,
  33. false.</value>
  34. </member>
  35. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor">
  36. <summary>
  37. Initializes a new instance of the <see
  38. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  39. class that is empty, has the default concurrency level, has the default initial capacity, and
  40. uses the default comparer for the item type.
  41. </summary>
  42. </member>
  43. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Int32,System.Int32)">
  44. <summary>
  45. Initializes a new instance of the <see
  46. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  47. class that is empty, has the specified concurrency level and capacity, and uses the default
  48. comparer for the item type.
  49. </summary>
  50. <param name="concurrencyLevel">The estimated number of threads that will update the
  51. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> concurrently.</param>
  52. <param name="capacity">The initial number of elements that the <see
  53. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  54. can contain.</param>
  55. <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="concurrencyLevel"/> is
  56. less than 1.</exception>
  57. <exception cref="T:System.ArgumentOutOfRangeException"> <paramref name="capacity"/> is less than
  58. 0.</exception>
  59. </member>
  60. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
  61. <summary>
  62. Initializes a new instance of the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  63. class that contains elements copied from the specified <see
  64. cref="T:System.Collections.IEnumerable{T}"/>, has the default concurrency
  65. level, has the default initial capacity, and uses the default comparer for the item type.
  66. </summary>
  67. <param name="collection">The <see
  68. cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to
  69. the new
  70. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</param>
  71. <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference.</exception>
  72. </member>
  73. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
  74. <summary>
  75. Initializes a new instance of the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  76. class that is empty, has the specified concurrency level and capacity, and uses the specified
  77. <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>.
  78. </summary>
  79. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>
  80. implementation to use when comparing items.</param>
  81. </member>
  82. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})">
  83. <summary>
  84. Initializes a new instance of the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  85. class that contains elements copied from the specified <see
  86. cref="T:System.Collections.IEnumerable"/>, has the default concurrency level, has the default
  87. initial capacity, and uses the specified
  88. <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>.
  89. </summary>
  90. <param name="collection">The <see
  91. cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to
  92. the new
  93. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</param>
  94. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>
  95. implementation to use when comparing items.</param>
  96. <exception cref="T:System.ArgumentNullException"><paramref name="collection"/> is a null reference
  97. (Nothing in Visual Basic).
  98. </exception>
  99. </member>
  100. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEqualityComparer{`0})">
  101. <summary>
  102. Initializes a new instance of the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  103. class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable"/>,
  104. has the specified concurrency level, has the specified initial capacity, and uses the specified
  105. <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>.
  106. </summary>
  107. <param name="concurrencyLevel">The estimated number of threads that will update the
  108. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> concurrently.</param>
  109. <param name="collection">The <see cref="T:System.Collections.IEnumerable{T}"/> whose elements are copied to the new
  110. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</param>
  111. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/> implementation to use
  112. when comparing items.</param>
  113. <exception cref="T:System.ArgumentNullException">
  114. <paramref name="collection"/> is a null reference.
  115. </exception>
  116. <exception cref="T:System.ArgumentOutOfRangeException">
  117. <paramref name="concurrencyLevel"/> is less than 1.
  118. </exception>
  119. </member>
  120. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.#ctor(System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
  121. <summary>
  122. Initializes a new instance of the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  123. class that is empty, has the specified concurrency level, has the specified initial capacity, and
  124. uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>.
  125. </summary>
  126. <param name="concurrencyLevel">The estimated number of threads that will update the
  127. <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> concurrently.</param>
  128. <param name="capacity">The initial number of elements that the <see
  129. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  130. can contain.</param>
  131. <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer{T}"/>
  132. implementation to use when comparing items.</param>
  133. <exception cref="T:System.ArgumentOutOfRangeException">
  134. <paramref name="concurrencyLevel"/> is less than 1. -or-
  135. <paramref name="capacity"/> is less than 0.
  136. </exception>
  137. </member>
  138. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.Add(`0)">
  139. <summary>
  140. Adds the specified item to the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.
  141. </summary>
  142. <param name="item">The item to add.</param>
  143. <returns>true if the items was added to the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  144. successfully; false if it already exists.</returns>
  145. <exception cref="T:System.OverflowException">The <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>
  146. contains too many items.</exception>
  147. </member>
  148. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.Clear">
  149. <summary>
  150. Removes all items from the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.
  151. </summary>
  152. </member>
  153. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.Contains(`0)">
  154. <summary>
  155. Determines whether the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> contains the specified
  156. item.
  157. </summary>
  158. <param name="item">The item to locate in the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</param>
  159. <returns>true if the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/> contains the item; otherwise, false.</returns>
  160. </member>
  161. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.TryRemove(`0)">
  162. <summary>
  163. Attempts to remove the item from the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.
  164. </summary>
  165. <param name="item">The item to remove.</param>
  166. <returns>true if an item was removed successfully; otherwise, false.</returns>
  167. </member>
  168. <member name="M:ConcurrentCollections.ConcurrentHashSet`1.GetEnumerator">
  169. <summary>Returns an enumerator that iterates through the <see
  170. cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</summary>
  171. <returns>An enumerator for the <see cref="T:ConcurrentCollections.ConcurrentHashSet`1"/>.</returns>
  172. <remarks>
  173. The enumerator returned from the collection is safe to use concurrently with
  174. reads and writes to the collection, however it does not represent a moment-in-time snapshot
  175. of the collection. The contents exposed through the enumerator may contain modifications
  176. made to the collection after <see cref="M:ConcurrentCollections.ConcurrentHashSet`1.GetEnumerator"/> was called.
  177. </remarks>
  178. </member>
  179. </members>
  180. </doc>