1133 lines
127 KiB
XML
1133 lines
127 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>System.Collections.Concurrent</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:System.Collections.Concurrent.BlockingCollection`1">
|
|
<summary>Provides blocking and bounding capabilities for thread-safe collections that implement <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<typeparam name="T">The type of elements in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.#ctor">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class without an upper-bound.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.#ctor(System.Collections.Concurrent.IProducerConsumerCollection{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class without an upper-bound and using the provided <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> as its underlying data store.</summary>
|
|
<param name="collection">The collection to use as the underlying data store.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.#ctor(System.Collections.Concurrent.IProducerConsumerCollection{`0},System.Int32)">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class with the specified upper-bound and using the provided <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> as its underlying data store.</summary>
|
|
<param name="collection">The collection to use as the underlying data store.</param>
|
|
<param name="boundedCapacity">The bounded size of the collection.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity" /> is not a positive value.</exception>
|
|
<exception cref="T:System.ArgumentException">The supplied <paramref name="collection" /> contains more values than is permitted by <paramref name="boundedCapacity" />.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.#ctor(System.Int32)">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class with the specified upper-bound.</summary>
|
|
<param name="boundedCapacity">The bounded size of the collection.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="boundedCapacity" /> is not a positive value.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0)">
|
|
<summary>Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<param name="item">The item to be added to the collection. The value can be a null reference.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0,System.Threading.CancellationToken)">
|
|
<summary>Adds the item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<param name="item">The item to be added to the collection. The value can be a null reference.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that owns <paramref name="cancellationToken" /> has been disposed.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.AddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0)">
|
|
<summary>Adds the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.AddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0,System.Threading.CancellationToken)">
|
|
<summary>Adds the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed, or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.BoundedCapacity">
|
|
<summary>Gets the bounded capacity of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</summary>
|
|
<returns>The bounded capacity of this collection, or int.MaxValue if no bound was supplied.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.CompleteAdding">
|
|
<summary>Marks the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances as not accepting any more additions.</summary>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.CopyTo(`0[],System.Int32)">
|
|
<summary>Copies all of the items in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance to a compatible one-dimensional array, starting at the specified index of the target array.</summary>
|
|
<param name="array">The one-dimensional array that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance. The array must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="array" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index" /> argument is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="index" /> argument is equal to or greater than the length of the <paramref name="array" />.The destination array is too small to hold all of the BlockingCcollection elements.The array rank doesn't match.The array type is incompatible with the type of the BlockingCollection elements.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.Count">
|
|
<summary>Gets the number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>The number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Dispose">
|
|
<summary>Releases all resources used by the current instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Dispose(System.Boolean)">
|
|
<summary>Releases resources used by the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</summary>
|
|
<param name="disposing">Whether being disposed explicitly (true) or due to a finalizer (false).</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.GetConsumingEnumerable">
|
|
<summary>Provides a consuming <see cref="T:System.Collections.Generic.IEnumerator`1" /> for items in the collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> that removes and returns items from the collection.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.GetConsumingEnumerable(System.Threading.CancellationToken)">
|
|
<summary>Provides a consuming <see cref="T:System.Collections.Generic.IEnumerable`1" /> for items in the collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> that removes and returns items from the collection.</returns>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.IsAddingCompleted">
|
|
<summary>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete for adding.</summary>
|
|
<returns>Whether this collection has been marked as complete for adding.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.IsCompleted">
|
|
<summary>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete for adding and is empty.</summary>
|
|
<returns>Whether this collection has been marked as complete for adding and is empty.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
|
|
<summary>Provides an <see cref="T:System.Collections.Generic.IEnumerator`1" /> for items in the collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.Generic.IEnumerator`1" /> for the items in the collection.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>Copies all of the items in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance to a compatible one-dimensional array, starting at the specified index of the target array.</summary>
|
|
<param name="array">The one-dimensional array that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance. The array must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="array" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index" /> argument is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="index" /> argument is equal to or greater than the length of the <paramref name="array" />, the array is multidimensional, or the type parameter for the collection cannot be cast automatically to the type of the destination array.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.System#Collections#ICollection#IsSynchronized">
|
|
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized.</summary>
|
|
<returns>always returns false.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.BlockingCollection`1.System#Collections#ICollection#SyncRoot">
|
|
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
|
|
<returns>returns null.</returns>
|
|
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Provides an <see cref="T:System.Collections.IEnumerator" /> for items in the collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the items in the collection.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Take">
|
|
<summary>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>The item removed from the collection.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance, or the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is empty and the collection has been marked as complete for adding.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.Take(System.Threading.CancellationToken)">
|
|
<summary>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>The item removed from the collection.</returns>
|
|
<param name="cancellationToken">Object that can be used to cancel the take operation.</param>
|
|
<exception cref="T:System.OperationCanceledException">The <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the <see cref="T:System.Threading.CancellationTokenSource" /> that created the token was canceled.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance or the BlockingCollection is marked as complete for adding, or the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is empty.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@)">
|
|
<summary>Takes an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element or <see cref="M:System.Collections.Concurrent.BlockingCollection`1.CompleteAdding" /> has been called on the collection.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@,System.Threading.CancellationToken)">
|
|
<summary>Takes an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances while observing the specified cancellation token.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or <see cref="M:System.Collections.Concurrent.BlockingCollection`1.CompleteAdding" /> has been called on the collection.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.ToArray">
|
|
<summary>Copies the items from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance into a new array.</summary>
|
|
<returns>An array containing copies of the elements of the collection.</returns>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0)">
|
|
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>true if <paramref name="item" /> could be added; otherwise false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an <see cref="T:System.InvalidOperationException" /> is thrown. </returns>
|
|
<param name="item">The item to be added to the collection.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.Int32)">
|
|
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> within the specified time period.</summary>
|
|
<returns>true if the <paramref name="item" /> could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an <see cref="T:System.InvalidOperationException" /> is thrown.</returns>
|
|
<param name="item">The item to be added to the collection.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> within the specified time period, while observing a cancellation token.</summary>
|
|
<returns>true if the <paramref name="item" /> could be added to the collection within the specified time; otherwise, false. If the item is a duplicate, and the underlying collection does not accept duplicate items, then an <see cref="T:System.InvalidOperationException" /> is thrown.</returns>
|
|
<param name="item">The item to be added to the collection.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the underlying <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0,System.TimeSpan)">
|
|
<summary>Tries to add the specified item to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>true if the <paramref name="item" /> could be added to the collection within the specified time span; otherwise, false.</returns>
|
|
<param name="item">The item to be added to the collection.</param>
|
|
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete with regards to additions.-or-The underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0)">
|
|
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0,System.Int32)">
|
|
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryAddToAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0,System.TimeSpan)">
|
|
<summary>Tries to add the specified item to any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances while observing the specified cancellation token.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array to which the item was added, or -1 if the item could not be added.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item to be added to one of the collections.</param>
|
|
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances or the <see cref="T:System.Threading.CancellationTokenSource" /> that created <paramref name="cancellationToken" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element, or at least one of collections has been marked as complete for adding.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one underlying collection didn't accept the item.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@)">
|
|
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</summary>
|
|
<returns>true if an item could be removed; otherwise, false.</returns>
|
|
<param name="item">The item to be removed from the collection.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@,System.Int32)">
|
|
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period.</summary>
|
|
<returns>true if an item could be removed from the collection within the specified time; otherwise, false.</returns>
|
|
<param name="item">The item to be removed from the collection.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period while observing a cancellation token.</summary>
|
|
<returns>true if an item could be removed from the collection within the specified time; otherwise, false.</returns>
|
|
<param name="item">The item to be removed from the collection.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">The <see cref="T:System.Threading.CancellationToken" /> has been canceled.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed or the underlying <see cref="T:System.Threading.CancellationTokenSource" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@,System.TimeSpan)">
|
|
<summary>Tries to remove an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in the specified time period.</summary>
|
|
<returns>true if an item could be removed from the collection within the specified time; otherwise, false.</returns>
|
|
<param name="item">The item to be removed from the collection.</param>
|
|
<param name="timeout">An object that represents the number of milliseconds to wait, or an object that represents -1 milliseconds to wait indefinitely. </param>
|
|
<exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out.-or- <paramref name="timeout" /> is greater than <see cref="F:System.Int32.MaxValue" />.</exception>
|
|
<exception cref="T:System.InvalidOperationException">The underlying collection was modified outside of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@)">
|
|
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@,System.Int32)">
|
|
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@,System.Int32,System.Threading.CancellationToken)">
|
|
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<param name="millisecondsTimeout">The number of milliseconds to wait, or <see cref="F:System.Threading.Timeout.Infinite" /> (-1) to wait indefinitely.</param>
|
|
<param name="cancellationToken">A cancellation token to observe.</param>
|
|
<exception cref="T:System.OperationCanceledException">If the <see cref="T:System.Threading.CancellationToken" /> is canceled.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="millisecondsTimeout" /> is a negative number other than -1, which represents an infinite time-out.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.BlockingCollection`1.TryTakeFromAny(System.Collections.Concurrent.BlockingCollection{`0}[],`0@,System.TimeSpan)">
|
|
<summary>Tries to remove an item from any one of the specified <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances.</summary>
|
|
<returns>The index of the collection in the <paramref name="collections" /> array from which the item was removed, or -1 if an item could not be removed.</returns>
|
|
<param name="collections">The array of collections.</param>
|
|
<param name="item">The item removed from one of the collections.</param>
|
|
<param name="timeout">A <see cref="T:System.TimeSpan" /> that represents the number of milliseconds to wait, or a <see cref="T:System.TimeSpan" /> that represents -1 milliseconds to wait indefinitely.</param>
|
|
<exception cref="T:System.ObjectDisposedException">At least one of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances has been disposed.</exception>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collections" /> argument is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="timeout" /> is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than <see cref="F:System.Int32.MaxValue" />.-or-The count of <paramref name="collections" /> is greater than the maximum size of 62 for STA and 63 for MTA.</exception>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="collections" /> argument is a 0-length array or contains a null element.</exception>
|
|
<exception cref="T:System.InvalidOperationException">At least one of the underlying collections was modified outside of its <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</exception>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.ConcurrentBag`1">
|
|
<summary>Represents a thread-safe, unordered collection of objects.</summary>
|
|
<typeparam name="T">The type of the elements to be stored in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.#ctor">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> class that contains elements copied from the specified collection.</summary>
|
|
<param name="collection">The collection whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="collection" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.Add(`0)">
|
|
<summary>Adds an object to the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<param name="item">The object to be added to the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.CopyTo(`0[],System.Int32)">
|
|
<summary>Copies the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> elements to an existing one-dimensional <see cref="T:System.Array" />, starting at the specified array index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- the number of elements in the source <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentBag`1.Count">
|
|
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<returns>The number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<returns>An enumerator for the contents of the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentBag`1.IsEmpty">
|
|
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> is empty.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> is empty; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryAdd(`0)">
|
|
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<returns>Always returns true</returns>
|
|
<param name="item">The object to be added to the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="array" /> is multidimensional. -or- <paramref name="array" /> does not have zero-based indexing. -or- <paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />. -or- The type of the source <see cref="T:System.Collections.ICollection" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentBag`1.System#Collections#ICollection#IsSynchronized">
|
|
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
|
|
<returns>true if access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot; otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />, this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentBag`1.System#Collections#ICollection#SyncRoot">
|
|
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
|
|
<returns>Returns null (Nothing in Visual Basic).</returns>
|
|
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<returns>An enumerator for the contents of the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.ToArray">
|
|
<summary>Copies the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> elements to a new array.</summary>
|
|
<returns>A new array containing a snapshot of elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.TryPeek(`0@)">
|
|
<summary>Attempts to return an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> without removing it.</summary>
|
|
<returns>true if and object was returned successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, <paramref name="result" /> contains an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> or the default value of <paramref name="T" /> if the operation failed.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentBag`1.TryTake(`0@)">
|
|
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />.</summary>
|
|
<returns>true if an object was removed successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, <paramref name="result" /> contains the object removed from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" /> or the default value of <paramref name="T" /> if the bag is empty.</param>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.ConcurrentDictionary`2">
|
|
<summary>Represents a thread-safe collection of key/value pairs that can be accessed by multiple threads concurrently. </summary>
|
|
<typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
|
|
<typeparam name="TValue">The type of the values in the dictionary.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that is empty, has the default concurrency level, has the default initial capacity, and uses the default comparer for the key type.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`0,`1}})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IEnumerable`1" />, has the default concurrency level, has the default initial capacity, and uses the default comparer for the key type.</summary>
|
|
<param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable`1" /> whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="collection" /> or any of its keys is null.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="collection" /> contains one or more duplicate keys.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`0,`1}},System.Collections.Generic.IEqualityComparer{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable" /> has the default concurrency level, has the default initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
|
|
<param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable`1" /> whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</param>
|
|
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="collection" /> or <paramref name="comparer" /> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that is empty, has the default concurrency level and capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
|
|
<param name="comparer">The equality comparison implementation to use when comparing keys.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="comparer" /> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Int32,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{`0,`1}},System.Collections.Generic.IEqualityComparer{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that contains elements copied from the specified <see cref="T:System.Collections.IEnumerable" />, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
|
|
<param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> concurrently.</param>
|
|
<param name="collection">The <see cref="T:System.Collections.Generic.IEnumerable`1" /> whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</param>
|
|
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="collection" /> or <paramref name="comparer" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="concurrencyLevel" /> is less than 1.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="collection" /> contains one or more duplicate keys.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Int32,System.Int32)">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that is empty, has the specified concurrency level and capacity, and uses the default comparer for the key type.</summary>
|
|
<param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> concurrently.</param>
|
|
<param name="capacity">The initial number of elements that the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> can contain.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="concurrencyLevel" /> is less than 1.-or-<paramref name="capacity" /> is less than 0.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.#ctor(System.Int32,System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> class that is empty, has the specified concurrency level, has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1" />.</summary>
|
|
<param name="concurrencyLevel">The estimated number of threads that will update the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> concurrently.</param>
|
|
<param name="capacity">The initial number of elements that the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> can contain.</param>
|
|
<param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1" /> implementation to use when comparing keys.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="comparer" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="concurrencyLevel" /> or <paramref name="capacity" /> is less than 1.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.AddOrUpdate(`0,System.Func{`0,`1},System.Func{`0,`1,`1})">
|
|
<summary>Uses the specified functions to add a key/value pair to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> if the key does not already exist, or to update a key/value pair in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> if the key already exists.</summary>
|
|
<returns>The new value for the key. This will be either be the result of addValueFactory (if the key was absent) or the result of updateValueFactory (if the key was present).</returns>
|
|
<param name="key">The key to be added or whose value should be updated</param>
|
|
<param name="addValueFactory">The function used to generate a value for an absent key</param>
|
|
<param name="updateValueFactory">The function used to generate a new value for an existing key based on the key's existing value</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" />, <paramref name="addValueFactory" />, or <paramref name="updateValueFactory" /> is null.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.AddOrUpdate(`0,`1,System.Func{`0,`1,`1})">
|
|
<summary>Adds a key/value pair to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> if the key does not already exist, or updates a key/value pair in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> by using the specified function if the key already exists.</summary>
|
|
<returns>The new value for the key. This will be either be addValue (if the key was absent) or the result of updateValueFactory (if the key was present).</returns>
|
|
<param name="key">The key to be added or whose value should be updated</param>
|
|
<param name="addValue">The value to be added for an absent key</param>
|
|
<param name="updateValueFactory">The function used to generate a new value for an existing key based on the key's existing value</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> or <paramref name="updateValueFactory" /> is null.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.Clear">
|
|
<summary>Removes all keys and values from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.ContainsKey(`0)">
|
|
<summary>Determines whether the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> contains the specified key.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> contains an element with the specified key; otherwise, false.</returns>
|
|
<param name="key">The key to locate in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.Count">
|
|
<summary>Gets the number of key/value pairs contained in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>The number of key/value pairs contained in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</returns>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>An enumerator for the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.GetOrAdd(`0,System.Func{`0,`1})">
|
|
<summary>Adds a key/value pair to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> by using the specified function, if the key does not already exist.</summary>
|
|
<returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value for the key as returned by valueFactory if the key was not in the dictionary.</returns>
|
|
<param name="key">The key of the element to add.</param>
|
|
<param name="valueFactory">The function used to generate a value for the key</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> or <paramref name="valueFactory" /> is null.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.GetOrAdd(`0,`1)">
|
|
<summary>Adds a key/value pair to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> if the key does not already exist.</summary>
|
|
<returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
|
|
<param name="key">The key of the element to add.</param>
|
|
<param name="value">the value to be added, if the key does not already exist</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.IsEmpty">
|
|
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> is empty.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> is empty; otherwise, false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.Item(`0)">
|
|
<summary>Gets or sets the value associated with the specified key.</summary>
|
|
<returns>The value of the key/value pair at the specified index.</returns>
|
|
<param name="key">The key of the value to get or set.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The property is retrieved and <paramref name="key" /> does not exist in the collection.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.Keys">
|
|
<summary>Gets a collection containing the keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
|
|
<returns>A collection of keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#ICollection{T}#Add(System.Collections.Generic.KeyValuePair{`0,`1})">
|
|
<summary>Adds an item to the collection.</summary>
|
|
<param name="keyValuePair">The <see cref="T:System.Collections.Generic.KeyValuePair`2" /> to add to the dictionary.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#ICollection{T}#Contains(System.Collections.Generic.KeyValuePair{`0,`1})">
|
|
<summary>Gets whether the <see cref="T:System.Collections.Generic.ICollection`1" /> contains an element with the specified key.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> contains an element with the specified key; otherwise, false.</returns>
|
|
<param name="keyValuePair">The key to locate in the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#ICollection{T}#CopyTo(System.Collections.Generic.KeyValuePair{`0,`1}[],System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an array, starting at the specified array index.</summary>
|
|
<param name="array">The one-dimensional array that is the destination of the elements copied from the <see cref="T:System.Collections.ICollection" />. The array must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#ICollection{T}#IsReadOnly">
|
|
<summary>Gets a value indicating whether the <see cref="T:System.Collections.ICollection" /> is read-only.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.ICollection" /> is read-only; otherwise, false. </returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#ICollection{T}#Remove(System.Collections.Generic.KeyValuePair{`0,`1})">
|
|
<summary>Removes the specified key/value pair from the collection.</summary>
|
|
<returns>true if the element is successfully remove; otherwise false. This method also returns false if <paramref name="key" /> was not found in the original <see cref="T:System.Collections.Generic.ICollection`1" />.</returns>
|
|
<param name="keyValuePair">The <see cref="T:System.Collections.Generic.KeyValuePair`2" /> to remove.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Add(`0,`1)">
|
|
<summary>Adds the specified key and value to the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
|
|
<param name="key">The object to use as the key of the element to add.</param>
|
|
<param name="value">The object to use as the value of the element to add.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">An element with the same key already exists in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#IDictionary{TKey@TValue}#Remove(`0)">
|
|
<summary>Removes the element with the specified key from the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
|
|
<returns>true if the element is successfully remove; otherwise false. This method also returns false if <paramref name="key" /> was not found in the original <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
|
|
<param name="key">The key of the element to remove.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Keys">
|
|
<summary>Gets a collection containing the keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
|
|
<returns>A collection containing the keys in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#Generic#IReadOnlyDictionary{TKey@TValue}#Values">
|
|
<summary>Gets a collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
|
|
<returns>A collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an array, starting at the specified array index.</summary>
|
|
<param name="array">The one-dimensional array that is the destination of the elements copied from the <see cref="T:System.Collections.ICollection" />. The array must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than 0.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="index" /> is equal to or greater than the length of the <paramref name="array" />. -or-The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#ICollection#IsSynchronized">
|
|
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
|
|
<returns>true if access to the <see cref="T:System.Collections.ICollection" /> is synchronized (thread safe); otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#ICollection#SyncRoot">
|
|
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
|
|
<returns>Always returns null.</returns>
|
|
<exception cref="T:System.NotSupportedException">This property is not supported.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Add(System.Object,System.Object)">
|
|
<summary>Adds the specified key and value to the dictionary.</summary>
|
|
<param name="key">The object to use as the key.</param>
|
|
<param name="value">The object to use as the value.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="key" /> is of a type that is not assignable to the key type of the <see cref="T:System.Collections.Generic.Dictionary`2" />. -or- <paramref name="value" /> is of a type that is not assignable to the type of values in the <see cref="T:System.Collections.Generic.Dictionary`2" />. -or-A value with the same key already exists in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Contains(System.Object)">
|
|
<summary>Gets whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the specified key.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Generic.IDictionary`2" /> contains an element with the specified key; otherwise, false.</returns>
|
|
<param name="key">The key to locate in the <see cref="T:System.Collections.Generic.IDictionary`2" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#GetEnumerator">
|
|
<summary>Provides a <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
|
|
<returns>A <see cref="T:System.Collections.IDictionaryEnumerator" /> for the <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#IsFixedSize">
|
|
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> has a fixed size.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Generic.IDictionary`2" /> has a fixed size; otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />, this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#IsReadOnly">
|
|
<summary>Gets a value indicating whether the <see cref="T:System.Collections.Generic.IDictionary`2" /> is read-only.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Generic.IDictionary`2" /> is read-only; otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />, this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Item(System.Object)">
|
|
<summary>Gets or sets the value associated with the specified key.</summary>
|
|
<returns>The value associated with the specified key, or null if <paramref name="key" /> is not in the dictionary or <paramref name="key" /> is of a type that is not assignable to the key type of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</returns>
|
|
<param name="key">The key of the value to get or set.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.ArgumentException">A value is being assigned, and <paramref name="key" /> is of a type that is not assignable to the key type or the value type of the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Keys">
|
|
<summary>Gets an <see cref="T:System.Collections.ICollection" /> that contains the keys of the <see cref="T:System.Collections.Generic.IDictionary`2" />.</summary>
|
|
<returns>An interface that contains the keys of the <see cref="T:System.Collections.Generic.IDictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Remove(System.Object)">
|
|
<summary>Removes the element with the specified key from the <see cref="T:System.Collections.IDictionary" />.</summary>
|
|
<param name="key">The key of the element to remove.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IDictionary#Values">
|
|
<summary>Gets an <see cref="T:System.Collections.ICollection" /> that contains the values in the <see cref="T:System.Collections.IDictionary" />.</summary>
|
|
<returns>An interface that contains the values in the <see cref="T:System.Collections.IDictionary" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>An enumerator for the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.ToArray">
|
|
<summary>Copies the key and value pairs stored in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> to a new array.</summary>
|
|
<returns>A new array containing a snapshot of key and value pairs copied from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.TryAdd(`0,`1)">
|
|
<summary>Attempts to add the specified key and value to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>true if the key/value pair was added to the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> successfully; false if the key already exists.</returns>
|
|
<param name="key">The key of the element to add.</param>
|
|
<param name="value">The value of the element to add. The value can be null for reference types.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
<exception cref="T:System.OverflowException">The dictionary already contains the maximum number of elements (<see cref="F:System.Int32.MaxValue" />).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.TryGetValue(`0,`1@)">
|
|
<summary>Attempts to get the value associated with the specified key from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>true if the key was found in the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />; otherwise, false.</returns>
|
|
<param name="key">The key of the value to get.</param>
|
|
<param name="value">When this method returns, contains the object from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" /> that has the specified key, or the default value of the type if the operation failed.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.TryRemove(`0,`1@)">
|
|
<summary>Attempts to remove and return the value that has the specified key from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />.</summary>
|
|
<returns>true if the object was removed successfully; otherwise, false.</returns>
|
|
<param name="key">The key of the element to remove and return.</param>
|
|
<param name="value">When this method returns, contains the object removed from the <see cref="T:System.Collections.Concurrent.ConcurrentDictionary`2" />, or the default value of the TValue type if <paramref name="key" /> does not exist. </param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentDictionary`2.TryUpdate(`0,`1,`1)">
|
|
<summary>Compares the existing value for the specified key with a specified value, and if they are equal, updates the key with a third value.</summary>
|
|
<returns>true if the value with <paramref name="key" /> was equal to <paramref name="comparisonValue" /> and was replaced with <paramref name="newValue" />; otherwise, false.</returns>
|
|
<param name="key">The key whose value is compared with <paramref name="comparisonValue" /> and possibly replaced.</param>
|
|
<param name="newValue">The value that replaces the value of the element that has the specified <paramref name="key" /> if the comparison results in equality.</param>
|
|
<param name="comparisonValue">The value that is compared to the value of the element that has the specified <paramref name="key" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="key" /> is null.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentDictionary`2.Values">
|
|
<summary>Gets a collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />.</summary>
|
|
<returns>A collection that contains the values in the <see cref="T:System.Collections.Generic.Dictionary`2" />. </returns>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.ConcurrentQueue`1">
|
|
<summary>Represents a thread-safe first in-first out (FIFO) collection.</summary>
|
|
<typeparam name="T">The type of the elements contained in the queue.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.#ctor">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> class that contains elements copied from the specified collection</summary>
|
|
<param name="collection">The collection whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.CopyTo(`0[],System.Int32)">
|
|
<summary>Copies the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> elements to an existing one-dimensional <see cref="T:System.Array" />, starting at the specified array index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the source <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentQueue`1.Count">
|
|
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</summary>
|
|
<returns>The number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.Enqueue(`0)">
|
|
<summary>Adds an object to the end of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</summary>
|
|
<param name="item">The object to add to the end of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</summary>
|
|
<returns>An enumerator for the contents of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentQueue`1.IsEmpty">
|
|
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> is empty.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> is empty; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryAdd(`0)">
|
|
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if the object was added successfully; otherwise, false.</returns>
|
|
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryTake(`0@)">
|
|
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if an element was removed and returned succesfully; otherwise, false.</returns>
|
|
<param name="item">When this method returns, if the operation was successful, <paramref name="item" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentBag`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="array" /> is multidimensional. -or- <paramref name="array" /> does not have zero-based indexing. -or- <paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />. -or- The type of the source <see cref="T:System.Collections.ICollection" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#ICollection#IsSynchronized">
|
|
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
|
|
<returns>true if access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot; otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />, this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#ICollection#SyncRoot">
|
|
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
|
|
<returns>Returns null (Nothing in Visual Basic).</returns>
|
|
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.ToArray">
|
|
<summary>Copies the elements stored in the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> to a new array.</summary>
|
|
<returns>A new array containing a snapshot of elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.TryDequeue(`0@)">
|
|
<summary>Tries to remove and return the object at the beginning of the concurrent queue.</summary>
|
|
<returns>true if an element was removed and returned from the beginning of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, if the operation was successful, <paramref name="result" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentQueue`1.TryPeek(`0@)">
|
|
<summary>Tries to return an object from the beginning of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> without removing it.</summary>
|
|
<returns>true if an object was returned successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, <paramref name="result" /> contains an object from the beginning of the <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> or an unspecified value if the operation failed.</param>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.ConcurrentStack`1">
|
|
<summary>Represents a thread-safe last in-first out (LIFO) collection.</summary>
|
|
<typeparam name="T">The type of the elements contained in the stack.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.#ctor">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> class.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
|
<summary>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> class that contains elements copied from the specified collection</summary>
|
|
<param name="collection">The collection whose elements are copied to the new <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">The <paramref name="collection" /> argument is null.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.Clear">
|
|
<summary>Removes all objects from the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.CopyTo(`0[],System.Int32)">
|
|
<summary>Copies the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> elements to an existing one-dimensional <see cref="T:System.Array" />, starting at the specified array index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the source <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentStack`1.Count">
|
|
<summary>Gets the number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
|
|
<returns>The number of elements contained in the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
|
|
<returns>An enumerator for the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentStack`1.IsEmpty">
|
|
<summary>Gets a value that indicates whether the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> is empty.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> is empty; otherwise, false.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.Push(`0)">
|
|
<summary>Inserts an object at the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
|
|
<param name="item">The object to push onto the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.PushRange(`0[])">
|
|
<summary>Inserts multiple objects at the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> atomically.</summary>
|
|
<param name="items">The objects to push onto the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="items" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.PushRange(`0[],System.Int32,System.Int32)">
|
|
<summary>Inserts multiple objects at the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> atomically.</summary>
|
|
<param name="items">The objects to push onto the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<param name="startIndex">The zero-based offset in <paramref name="items" /> at which to begin inserting elements onto the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<param name="count">The number of elements to be inserted onto the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="items" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="startIndex" /> or <paramref name="count" /> is negative. Or <paramref name="startIndex" /> is greater than or equal to the length of <paramref name="items" />.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="startIndex" /> + <paramref name="count" /> is greater than the length of <paramref name="items" />.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryAdd(`0)">
|
|
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if the object was added successfully; otherwise, false.</returns>
|
|
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The value can be a null reference (Nothing in Visual Basic) for reference types.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#Concurrent#IProducerConsumerCollection{T}#TryTake(`0@)">
|
|
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if an element was removed and returned succesfully; otherwise, false.</returns>
|
|
<param name="item">When this method returns, if the operation was successful, <paramref name="item" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.ICollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="array" /> is multidimensional. -or- <paramref name="array" /> does not have zero-based indexing. -or- <paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the source <see cref="T:System.Collections.ICollection" /> is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />. -or- The type of the source <see cref="T:System.Collections.ICollection" /> cannot be cast automatically to the type of the destination <paramref name="array" />.</exception>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#ICollection#IsSynchronized">
|
|
<summary>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot.</summary>
|
|
<returns>true if access to the <see cref="T:System.Collections.ICollection" /> is synchronized with the SyncRoot; otherwise, false. For <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />, this property always returns false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#ICollection#SyncRoot">
|
|
<summary>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</summary>
|
|
<returns>Returns null (Nothing in Visual Basic).</returns>
|
|
<exception cref="T:System.NotSupportedException">The SyncRoot property is not supported</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>Returns an enumerator that iterates through a collection.</summary>
|
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.ToArray">
|
|
<summary>Copies the items stored in the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> to a new array.</summary>
|
|
<returns>A new array containing a snapshot of elements copied from the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPeek(`0@)">
|
|
<summary>Attempts to return an object from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> without removing it.</summary>
|
|
<returns>true if and object was returned successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, <paramref name="result" /> contains an object from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />or an unspecified value if the operation failed.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPop(`0@)">
|
|
<summary>Attempts to pop and return the object at the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</summary>
|
|
<returns>true if an element was removed and returned from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> successfully; otherwise, false.</returns>
|
|
<param name="result">When this method returns, if the operation was successful, <paramref name="result" /> contains the object removed. If no object was available to be removed, the value is unspecified.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPopRange(`0[])">
|
|
<summary>Attempts to pop and return multiple objects from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> atomically.</summary>
|
|
<returns>The number of objects successfully popped from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> and inserted in <paramref name="items" />.</returns>
|
|
<param name="items">The <see cref="T:System.Array" /> to which objects popped from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> will be added.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="items" /> is a null argument (Nothing in Visual Basic).</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.ConcurrentStack`1.TryPopRange(`0[],System.Int32,System.Int32)">
|
|
<summary>Attempts to pop and return multiple objects from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> atomically.</summary>
|
|
<returns>The number of objects successfully popped from the top of the stack and inserted in <paramref name="items" />.</returns>
|
|
<param name="items">The <see cref="T:System.Array" /> to which objects popped from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> will be added.</param>
|
|
<param name="startIndex">The zero-based offset in <paramref name="items" /> at which to begin inserting elements from the top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" />.</param>
|
|
<param name="count">The number of elements to be popped from top of the <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> and inserted into <paramref name="items" />.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="items" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="startIndex" /> or <paramref name="count" /> is negative. Or <paramref name="startIndex" /> is greater than or equal to the length of <paramref name="items" />.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="startIndex" /> + <paramref name="count" /> is greater than the length of <paramref name="items" />.</exception>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.EnumerablePartitionerOptions">
|
|
<summary>Specifies options to control the buffering behavior of a partitioner</summary>
|
|
</member>
|
|
<member name="F:System.Collections.Concurrent.EnumerablePartitionerOptions.NoBuffering">
|
|
<summary>Create a partitioner that takes items from the source enumerable one at a time and does not use intermediate storage that can be accessed more efficiently by multiple threads. This option provides support for low latency (items will be processed as soon as they are available from the source) and provides partial support for dependencies between items (a thread cannot deadlock waiting for an item that the thread itself is responsible for processing).</summary>
|
|
</member>
|
|
<member name="F:System.Collections.Concurrent.EnumerablePartitionerOptions.None">
|
|
<summary>Use the default behavior, which is to use buffering to achieve optimal performance.</summary>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.IProducerConsumerCollection`1">
|
|
<summary>Defines methods to manipulate thread-safe collections intended for producer/consumer usage. This interface provides a unified representation for producer/consumer collections so that higher level abstractions such as <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> can use the collection as the underlying storage mechanism.</summary>
|
|
<typeparam name="T">Specifies the type of elements in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.CopyTo(`0[],System.Int32)">
|
|
<summary>Copies the elements of the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> to an <see cref="T:System.Array" />, starting at a specified index.</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />. The array must have zero-based indexing.</param>
|
|
<param name="index">The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
|
<exception cref="T:System.ArgumentNullException">
|
|
<paramref name="array" /> is a null reference (Nothing in Visual Basic).</exception>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
<paramref name="index" /> is less than zero.</exception>
|
|
<exception cref="T:System.ArgumentException">
|
|
<paramref name="index" /> is equal to or greater than the length of the <paramref name="array" /> -or- The number of elements in the collection is greater than the available space from <paramref name="index" /> to the end of the destination <paramref name="array" />. </exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.ToArray">
|
|
<summary>Copies the elements contained in the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> to a new array.</summary>
|
|
<returns>A new array containing the elements copied from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</returns>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.TryAdd(`0)">
|
|
<summary>Attempts to add an object to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if the object was added successfully; otherwise, false.</returns>
|
|
<param name="item">The object to add to the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</param>
|
|
<exception cref="T:System.ArgumentException">The <paramref name="item" /> was invalid for this collection.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.IProducerConsumerCollection`1.TryTake(`0@)">
|
|
<summary>Attempts to remove and return an object from the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</summary>
|
|
<returns>true if an object was removed and returned successfully; otherwise, false.</returns>
|
|
<param name="item">When this method returns, if the object was removed and returned successfully, <paramref name="item" /> contains the removed object. If no object was available to be removed, the value is unspecified.</param>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.OrderablePartitioner`1">
|
|
<summary>Represents a particular manner of splitting an orderable data source into multiple partitions.</summary>
|
|
<typeparam name="TSource">Type of the elements in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.OrderablePartitioner`1.#ctor(System.Boolean,System.Boolean,System.Boolean)">
|
|
<summary>Called from constructors in derived classes to initialize the <see cref="T:System.Collections.Concurrent.OrderablePartitioner`1" /> class with the specified constraints on the index keys.</summary>
|
|
<param name="keysOrderedInEachPartition">Indicates whether the elements in each partition are yielded in the order of increasing keys.</param>
|
|
<param name="keysOrderedAcrossPartitions">Indicates whether elements in an earlier partition always come before elements in a later partition. If true, each element in partition 0 has a smaller order key than any element in partition 1, each element in partition 1 has a smaller order key than any element in partition 2, and so on.</param>
|
|
<param name="keysNormalized">Indicates whether keys are normalized. If true, all order keys are distinct integers in the range [0 .. numberOfElements-1]. If false, order keys must still be distinct, but only their relative order is considered, not their absolute values.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.OrderablePartitioner`1.GetDynamicPartitions">
|
|
<summary>Creates an object that can partition the underlying collection into a variable number of partitions.</summary>
|
|
<returns>An object that can create partitions over the underlying data source.</returns>
|
|
<exception cref="T:System.NotSupportedException">Dynamic partitioning is not supported by the base class. It must be implemented in derived classes.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.OrderablePartitioner`1.GetOrderableDynamicPartitions">
|
|
<summary>Creates an object that can partition the underlying collection into a variable number of partitions.</summary>
|
|
<returns>An object that can create partitions over the underlying data source.</returns>
|
|
<exception cref="T:System.NotSupportedException">Dynamic partitioning is not supported by this partitioner.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.OrderablePartitioner`1.GetOrderablePartitions(System.Int32)">
|
|
<summary>Partitions the underlying collection into the specified number of orderable partitions.</summary>
|
|
<returns>A list containing <paramref name="partitionCount" /> enumerators.</returns>
|
|
<param name="partitionCount">The number of partitions to create.</param>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.OrderablePartitioner`1.GetPartitions(System.Int32)">
|
|
<summary>Partitions the underlying collection into the given number of ordered partitions.</summary>
|
|
<returns>A list containing <paramref name="partitionCount" /> enumerators.</returns>
|
|
<param name="partitionCount">The number of partitions to create.</param>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.OrderablePartitioner`1.KeysNormalized">
|
|
<summary>Gets whether order keys are normalized.</summary>
|
|
<returns>true if the keys are normalized; otherwise false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.OrderablePartitioner`1.KeysOrderedAcrossPartitions">
|
|
<summary>Gets whether elements in an earlier partition always come before elements in a later partition.</summary>
|
|
<returns>true if the elements in an earlier partition always come before elements in a later partition; otherwise false.</returns>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.OrderablePartitioner`1.KeysOrderedInEachPartition">
|
|
<summary>Gets whether elements in each partition are yielded in the order of increasing keys.</summary>
|
|
<returns>true if the elements in each partition are yielded in the order of increasing keys; otherwise false.</returns>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.Partitioner">
|
|
<summary>Provides common partitioning strategies for arrays, lists, and enumerables.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create``1(System.Collections.Generic.IEnumerable{``0})">
|
|
<summary>Creates an orderable partitioner from a <see cref="T:System.Collections.Generic.IEnumerable`1" /> instance.</summary>
|
|
<returns>An orderable partitioner based on the input array.</returns>
|
|
<param name="source">The enumerable to be partitioned.</param>
|
|
<typeparam name="TSource">Type of the elements in source enumerable.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create``1(System.Collections.Generic.IEnumerable{``0},System.Collections.Concurrent.EnumerablePartitionerOptions)">
|
|
<summary>Creates an orderable partitioner from a <see cref="T:System.Collections.Generic.IEnumerable`1" /> instance.</summary>
|
|
<returns>An orderable partitioner based on the input array.</returns>
|
|
<param name="source">The enumerable to be partitioned.</param>
|
|
<param name="partitionerOptions">Options to control the buffering behavior of the partitioner.</param>
|
|
<typeparam name="TSource">Type of the elements in source enumerable.</typeparam>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="partitionerOptions" /> argument specifies an invalid value for <see cref="T:System.Collections.Concurrent.EnumerablePartitionerOptions" />.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create``1(System.Collections.Generic.IList{``0},System.Boolean)">
|
|
<summary>Creates an orderable partitioner from an <see cref="T:System.Collections.Generic.IList`1" /> instance.</summary>
|
|
<returns>An orderable partitioner based on the input list.</returns>
|
|
<param name="list">The list to be partitioned.</param>
|
|
<param name="loadBalance">A Boolean value that indicates whether the created partitioner should dynamically load balance between partitions rather than statically partition.</param>
|
|
<typeparam name="TSource">Type of the elements in source list.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create(System.Int32,System.Int32)">
|
|
<summary>Creates a partitioner that chunks the user-specified range.</summary>
|
|
<returns>A partitioner.</returns>
|
|
<param name="fromInclusive">The lower, inclusive bound of the range.</param>
|
|
<param name="toExclusive">The upper, exclusive bound of the range.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create(System.Int32,System.Int32,System.Int32)">
|
|
<summary>Creates a partitioner that chunks the user-specified range.</summary>
|
|
<returns>A partitioner.</returns>
|
|
<param name="fromInclusive">The lower, inclusive bound of the range.</param>
|
|
<param name="toExclusive">The upper, exclusive bound of the range.</param>
|
|
<param name="rangeSize">The size of each subrange.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.-or-The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create(System.Int64,System.Int64)">
|
|
<summary>Creates a partitioner that chunks the user-specified range.</summary>
|
|
<returns>A partitioner.</returns>
|
|
<param name="fromInclusive">The lower, inclusive bound of the range.</param>
|
|
<param name="toExclusive">The upper, exclusive bound of the range.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create(System.Int64,System.Int64,System.Int64)">
|
|
<summary>Creates a partitioner that chunks the user-specified range.</summary>
|
|
<returns>A partitioner.</returns>
|
|
<param name="fromInclusive">The lower, inclusive bound of the range.</param>
|
|
<param name="toExclusive">The upper, exclusive bound of the range.</param>
|
|
<param name="rangeSize">The size of each subrange.</param>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="toExclusive" /> argument is less than or equal to the <paramref name="fromInclusive" /> argument.-or-The <paramref name="rangeSize" /> argument is less than or equal to 0.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner.Create``1(``0[],System.Boolean)">
|
|
<summary>Creates an orderable partitioner from a <see cref="T:System.Array" /> instance.</summary>
|
|
<returns>An orderable partitioner based on the input array.</returns>
|
|
<param name="array">The array to be partitioned.</param>
|
|
<param name="loadBalance">A Boolean value that indicates whether the created partitioner should dynamically load balance between partitions rather than statically partition.</param>
|
|
<typeparam name="TSource">Type of the elements in source array.</typeparam>
|
|
</member>
|
|
<member name="T:System.Collections.Concurrent.Partitioner`1">
|
|
<summary>Represents a particular manner of splitting a data source into multiple partitions.</summary>
|
|
<typeparam name="TSource">Type of the elements in the collection.</typeparam>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner`1.#ctor">
|
|
<summary>Creates a new partitioner instance.</summary>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner`1.GetDynamicPartitions">
|
|
<summary>Creates an object that can partition the underlying collection into a variable number of partitions.</summary>
|
|
<returns>An object that can create partitions over the underlying data source.</returns>
|
|
<exception cref="T:System.NotSupportedException">Dynamic partitioning is not supported by the base class. You must implement it in a derived class.</exception>
|
|
</member>
|
|
<member name="M:System.Collections.Concurrent.Partitioner`1.GetPartitions(System.Int32)">
|
|
<summary>Partitions the underlying collection into the given number of partitions.</summary>
|
|
<returns>A list containing <paramref name="partitionCount" /> enumerators.</returns>
|
|
<param name="partitionCount">The number of partitions to create.</param>
|
|
</member>
|
|
<member name="P:System.Collections.Concurrent.Partitioner`1.SupportsDynamicPartitions">
|
|
<summary>Gets whether additional partitions can be created dynamically.</summary>
|
|
<returns>true if the <see cref="T:System.Collections.Concurrent.Partitioner`1" /> can create partitions dynamically as they are requested; false if the <see cref="T:System.Collections.Concurrent.Partitioner`1" /> can only allocate partitions statically.</returns>
|
|
</member>
|
|
</members>
|
|
</doc> |