BlockingCollection(T) Class

BlockingCollection<T> Class

.NET Framework (current version)
 

Provides blocking and bounding capabilities for thread-safe collections that implement IProducerConsumerCollection<T>.

Namespace:   System.Collections.Concurrent
Assembly:  System (in System.dll)

System.Object
  System.Collections.Concurrent.BlockingCollection<T>

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public class BlockingCollection<T> : IEnumerable<T>, IEnumerable, 
	ICollection, IDisposable, IReadOnlyCollection<T>

Type Parameters

T

The type of elements in the collection.

NameDescription
System_CAPS_pubmethodBlockingCollection<T>()

Initializes a new instance of the BlockingCollection<T> class without an upper-bound.

System_CAPS_pubmethodBlockingCollection<T>(Int32)

Initializes a new instance of the BlockingCollection<T> class with the specified upper-bound.

System_CAPS_pubmethodBlockingCollection<T>(IProducerConsumerCollection<T>)

Initializes a new instance of the BlockingCollection<T> class without an upper-bound and using the provided IProducerConsumerCollection<T> as its underlying data store.

System_CAPS_pubmethodBlockingCollection<T>(IProducerConsumerCollection<T>, Int32)

Initializes a new instance of the BlockingCollection<T> class with the specified upper-bound and using the provided IProducerConsumerCollection<T> as its underlying data store.

NameDescription
System_CAPS_pubpropertyBoundedCapacity

Gets the bounded capacity of this BlockingCollection<T> instance.

System_CAPS_pubpropertyCount

Gets the number of items contained in the BlockingCollection<T>.

System_CAPS_pubpropertyIsAddingCompleted

Gets whether this BlockingCollection<T> has been marked as complete for adding.

System_CAPS_pubpropertyIsCompleted

Gets whether this BlockingCollection<T> has been marked as complete for adding and is empty.

NameDescription
System_CAPS_pubmethodAdd(T)

Adds the item to the BlockingCollection<T>.

System_CAPS_pubmethodAdd(T, CancellationToken)

Adds the item to the BlockingCollection<T>.

System_CAPS_pubmethodSystem_CAPS_staticAddToAny(BlockingCollection<T>[], T)

Adds the specified item to any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticAddToAny(BlockingCollection<T>[], T, CancellationToken)

Adds the specified item to any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodCompleteAdding()

Marks the BlockingCollection<T> instances as not accepting any more additions.

System_CAPS_pubmethodCopyTo(T[], Int32)

Copies all of the items in the BlockingCollection<T> instance to a compatible one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubmethodDispose()

Releases all resources used by the current instance of the BlockingCollection<T> class.

System_CAPS_protmethodDispose(Boolean)

Releases resources used by the BlockingCollection<T> instance.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetConsumingEnumerable()

Provides a consuming IEnumerator<T> for items in the collection.

System_CAPS_pubmethodGetConsumingEnumerable(CancellationToken)

Provides a consuming IEnumerable<T> for items in the collection.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodTake()

Removes an item from the BlockingCollection<T>.

System_CAPS_pubmethodTake(CancellationToken)

Removes an item from the BlockingCollection<T>.

System_CAPS_pubmethodSystem_CAPS_staticTakeFromAny(BlockingCollection<T>[], T)

Takes an item from any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTakeFromAny(BlockingCollection<T>[], T, CancellationToken)

Takes an item from any one of the specified BlockingCollection<T> instances while observing the specified cancellation token.

System_CAPS_pubmethodToArray()

Copies the items from the BlockingCollection<T> instance into a new array.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodTryAdd(T)

Tries to add the specified item to the BlockingCollection<T>.

System_CAPS_pubmethodTryAdd(T, Int32)

Tries to add the specified item to the BlockingCollection<T> within the specified time period.

System_CAPS_pubmethodTryAdd(T, Int32, CancellationToken)

Tries to add the specified item to the BlockingCollection<T> within the specified time period, while observing a cancellation token.

System_CAPS_pubmethodTryAdd(T, TimeSpan)

Tries to add the specified item to the BlockingCollection<T>.

System_CAPS_pubmethodSystem_CAPS_staticTryAddToAny(BlockingCollection<T>[], T)

Tries to add the specified item to any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryAddToAny(BlockingCollection<T>[], T, Int32)

Tries to add the specified item to any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryAddToAny(BlockingCollection<T>[], T, Int32, CancellationToken)

Tries to add the specified item to any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryAddToAny(BlockingCollection<T>[], T, TimeSpan)

Tries to add the specified item to any one of the specified BlockingCollection<T> instances while observing the specified cancellation token.

System_CAPS_pubmethodTryTake(T)

Tries to remove an item from the BlockingCollection<T>.

System_CAPS_pubmethodTryTake(T, Int32)

Tries to remove an item from the BlockingCollection<T> in the specified time period.

System_CAPS_pubmethodTryTake(T, Int32, CancellationToken)

Tries to remove an item from the BlockingCollection<T> in the specified time period while observing a cancellation token.

System_CAPS_pubmethodTryTake(T, TimeSpan)

Tries to remove an item from the BlockingCollection<T> in the specified time period.

System_CAPS_pubmethodSystem_CAPS_staticTryTakeFromAny(BlockingCollection<T>[], T)

Tries to remove an item from any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryTakeFromAny(BlockingCollection<T>[], T, Int32)

Tries to remove an item from any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryTakeFromAny(BlockingCollection<T>[], T, Int32, CancellationToken)

Tries to remove an item from any one of the specified BlockingCollection<T> instances.

System_CAPS_pubmethodSystem_CAPS_staticTryTakeFromAny(BlockingCollection<T>[], T, TimeSpan)

Tries to remove an item from any one of the specified BlockingCollection<T> instances.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable<T>.GetEnumerator()

Provides an IEnumerator<T> for items in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.CopyTo(Array, Int32)

Copies all of the items in the BlockingCollection<T> instance to a compatible one-dimensional array, starting at the specified index of the target array.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIEnumerable.GetEnumerator()

Provides an IEnumerator for items in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to the ICollection is synchronized.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to the ICollection. This property is not supported.

NameDescription
System_CAPS_pubmethodAggregate<T>(Func<T, T, T>)

Overloaded. Applies an accumulator function over a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAggregate<T, TAccumulate>(TAccumulate, Func<TAccumulate, T, TAccumulate>)

Overloaded. Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value.(Defined by Enumerable.)

System_CAPS_pubmethodAggregate<T, TAccumulate, TResult>(TAccumulate, Func<TAccumulate, T, TAccumulate>, Func<TAccumulate, TResult>)

Overloaded. Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value, and the specified function is used to select the result value.(Defined by Enumerable.)

System_CAPS_pubmethodAll<T>(Func<T, Boolean>)

Determines whether all elements of a sequence satisfy a condition.(Defined by Enumerable.)

System_CAPS_pubmethodAny<T>()

Overloaded. Determines whether a sequence contains any elements.(Defined by Enumerable.)

System_CAPS_pubmethodAny<T>(Func<T, Boolean>)

Overloaded. Determines whether any element of a sequence satisfies a condition.(Defined by Enumerable.)

System_CAPS_pubmethodAsEnumerable<T>()

Returns the input typed as IEnumerable<T>.(Defined by Enumerable.)

System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsParallel<T>()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodAsQueryable<T>()

Overloaded. Converts a generic IEnumerable<T> to a generic IQueryable<T>.(Defined by Queryable.)

System_CAPS_pubmethodAverage<T>(Func<T, Decimal>)

Overloaded. Computes the average of a sequence of Decimal values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Double>)

Overloaded. Computes the average of a sequence of Double values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Int32>)

Overloaded. Computes the average of a sequence of Int32 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Int64>)

Overloaded. Computes the average of a sequence of Int64 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Nullable<Decimal>>)

Overloaded. Computes the average of a sequence of nullable Decimal values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Nullable<Double>>)

Overloaded. Computes the average of a sequence of nullable Double values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Nullable<Int32>>)

Overloaded. Computes the average of a sequence of nullable Int32 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Nullable<Int64>>)

Overloaded. Computes the average of a sequence of nullable Int64 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Nullable<Single>>)

Overloaded. Computes the average of a sequence of nullable Single values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodAverage<T>(Func<T, Single>)

Overloaded. Computes the average of a sequence of Single values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodConcat<T>(IEnumerable<T>)

Concatenates two sequences.(Defined by Enumerable.)

System_CAPS_pubmethodContains<T>(T)

Overloaded. Determines whether a sequence contains a specified element by using the default equality comparer.(Defined by Enumerable.)

System_CAPS_pubmethodContains<T>(T, IEqualityComparer<T>)

Overloaded. Determines whether a sequence contains a specified element by using a specified IEqualityComparer<T>.(Defined by Enumerable.)

System_CAPS_pubmethodCount<T>()

Overloaded. Returns the number of elements in a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodCount<T>(Func<T, Boolean>)

Overloaded. Returns a number that represents how many elements in the specified sequence satisfy a condition.(Defined by Enumerable.)

System_CAPS_pubmethodDefaultIfEmpty<T>()

Overloaded. Returns the elements of the specified sequence or the type parameter's default value in a singleton collection if the sequence is empty.(Defined by Enumerable.)

System_CAPS_pubmethodDefaultIfEmpty<T>(T)

Overloaded. Returns the elements of the specified sequence or the specified value in a singleton collection if the sequence is empty.(Defined by Enumerable.)

System_CAPS_pubmethodDistinct<T>()

Overloaded. Returns distinct elements from a sequence by using the default equality comparer to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodDistinct<T>(IEqualityComparer<T>)

Overloaded. Returns distinct elements from a sequence by using a specified IEqualityComparer<T> to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodElementAt<T>(Int32)

Returns the element at a specified index in a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodElementAtOrDefault<T>(Int32)

Returns the element at a specified index in a sequence or a default value if the index is out of range.(Defined by Enumerable.)

System_CAPS_pubmethodExcept<T>(IEnumerable<T>)

Overloaded. Produces the set difference of two sequences by using the default equality comparer to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodExcept<T>(IEnumerable<T>, IEqualityComparer<T>)

Overloaded. Produces the set difference of two sequences by using the specified IEqualityComparer<T> to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodFirst<T>()

Overloaded. Returns the first element of a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodFirst<T>(Func<T, Boolean>)

Overloaded. Returns the first element in a sequence that satisfies a specified condition.(Defined by Enumerable.)

System_CAPS_pubmethodFirstOrDefault<T>()

Overloaded. Returns the first element of a sequence, or a default value if the sequence contains no elements.(Defined by Enumerable.)

System_CAPS_pubmethodFirstOrDefault<T>(Func<T, Boolean>)

Overloaded. Returns the first element of the sequence that satisfies a condition or a default value if no such element is found.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey>(Func<T, TKey>)

Overloaded. Groups the elements of a sequence according to a specified key selector function.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey>(Func<T, TKey>, IEqualityComparer<TKey>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and compares the keys by using a specified comparer.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and projects the elements for each group by using a specified function.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>)

Overloaded. Groups the elements of a sequence according to a key selector function. The keys are compared by using a comparer and each group's elements are projected by using a specified function.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TResult>(Func<T, TKey>, Func<TKey, IEnumerable<T>, TResult>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TResult>(Func<T, TKey>, Func<TKey, IEnumerable<T>, TResult>, IEqualityComparer<TKey>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The keys are compared by using a specified comparer.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TElement, TResult>(Func<T, TKey>, Func<T, TElement>, Func<TKey, IEnumerable<TElement>, TResult>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. The elements of each group are projected by using a specified function.(Defined by Enumerable.)

System_CAPS_pubmethodGroupBy<T, TKey, TElement, TResult>(Func<T, TKey>, Func<T, TElement>, Func<TKey, IEnumerable<TElement>, TResult>, IEqualityComparer<TKey>)

Overloaded. Groups the elements of a sequence according to a specified key selector function and creates a result value from each group and its key. Key values are compared by using a specified comparer, and the elements of each group are projected by using a specified function.(Defined by Enumerable.)

System_CAPS_pubmethodGroupJoin<T, TInner, TKey, TResult>(IEnumerable<TInner>, Func<T, TKey>, Func<TInner, TKey>, Func<T, IEnumerable<TInner>, TResult>)

Overloaded. Correlates the elements of two sequences based on equality of keys and groups the results. The default equality comparer is used to compare keys.(Defined by Enumerable.)

System_CAPS_pubmethodGroupJoin<T, TInner, TKey, TResult>(IEnumerable<TInner>, Func<T, TKey>, Func<TInner, TKey>, Func<T, IEnumerable<TInner>, TResult>, IEqualityComparer<TKey>)

Overloaded. Correlates the elements of two sequences based on key equality and groups the results. A specified IEqualityComparer<T> is used to compare keys.(Defined by Enumerable.)

System_CAPS_pubmethodIntersect<T>(IEnumerable<T>)

Overloaded. Produces the set intersection of two sequences by using the default equality comparer to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodIntersect<T>(IEnumerable<T>, IEqualityComparer<T>)

Overloaded. Produces the set intersection of two sequences by using the specified IEqualityComparer<T> to compare values.(Defined by Enumerable.)

System_CAPS_pubmethodJoin<T, TInner, TKey, TResult>(IEnumerable<TInner>, Func<T, TKey>, Func<TInner, TKey>, Func<T, TInner, TResult>)

Overloaded. Correlates the elements of two sequences based on matching keys. The default equality comparer is used to compare keys.(Defined by Enumerable.)

System_CAPS_pubmethodJoin<T, TInner, TKey, TResult>(IEnumerable<TInner>, Func<T, TKey>, Func<TInner, TKey>, Func<T, TInner, TResult>, IEqualityComparer<TKey>)

Overloaded. Correlates the elements of two sequences based on matching keys. A specified IEqualityComparer<T> is used to compare keys.(Defined by Enumerable.)

System_CAPS_pubmethodLast<T>()

Overloaded. Returns the last element of a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodLast<T>(Func<T, Boolean>)

Overloaded. Returns the last element of a sequence that satisfies a specified condition.(Defined by Enumerable.)

System_CAPS_pubmethodLastOrDefault<T>()

Overloaded. Returns the last element of a sequence, or a default value if the sequence contains no elements.(Defined by Enumerable.)

System_CAPS_pubmethodLastOrDefault<T>(Func<T, Boolean>)

Overloaded. Returns the last element of a sequence that satisfies a condition or a default value if no such element is found.(Defined by Enumerable.)

System_CAPS_pubmethodLongCount<T>()

Overloaded. Returns an Int64 that represents the total number of elements in a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodLongCount<T>(Func<T, Boolean>)

Overloaded. Returns an Int64 that represents how many elements in a sequence satisfy a condition.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>()

Overloaded. Returns the maximum value in a generic sequence.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Decimal>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum Decimal value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Double>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum Double value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Int32>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum Int32 value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Int64>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum Int64 value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Nullable<Decimal>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum nullable Decimal value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Nullable<Double>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum nullable Double value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Nullable<Int32>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum nullable Int32 value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Nullable<Int64>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum nullable Int64 value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Nullable<Single>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum nullable Single value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T>(Func<T, Single>)

Overloaded. Invokes a transform function on each element of a sequence and returns the maximum Single value.(Defined by Enumerable.)

System_CAPS_pubmethodMax<T, TResult>(Func<T, TResult>)

Overloaded. Invokes a transform function on each element of a generic sequence and returns the maximum resulting value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>()

Overloaded. Returns the minimum value in a generic sequence.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Decimal>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum Decimal value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Double>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum Double value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Int32>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum Int32 value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Int64>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum Int64 value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Nullable<Decimal>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum nullable Decimal value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Nullable<Double>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum nullable Double value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Nullable<Int32>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum nullable Int32 value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Nullable<Int64>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum nullable Int64 value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Nullable<Single>>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum nullable Single value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T>(Func<T, Single>)

Overloaded. Invokes a transform function on each element of a sequence and returns the minimum Single value.(Defined by Enumerable.)

System_CAPS_pubmethodMin<T, TResult>(Func<T, TResult>)

Overloaded. Invokes a transform function on each element of a generic sequence and returns the minimum resulting value.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOrderBy<T, TKey>(Func<T, TKey>)

Overloaded. Sorts the elements of a sequence in ascending order according to a key.(Defined by Enumerable.)

System_CAPS_pubmethodOrderBy<T, TKey>(Func<T, TKey>, IComparer<TKey>)

Overloaded. Sorts the elements of a sequence in ascending order by using a specified comparer.(Defined by Enumerable.)

System_CAPS_pubmethodOrderByDescending<T, TKey>(Func<T, TKey>)

Overloaded. Sorts the elements of a sequence in descending order according to a key.(Defined by Enumerable.)

System_CAPS_pubmethodOrderByDescending<T, TKey>(Func<T, TKey>, IComparer<TKey>)

Overloaded. Sorts the elements of a sequence in descending order by using a specified comparer.(Defined by Enumerable.)

System_CAPS_pubmethodReverse<T>()

Inverts the order of the elements in a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSelect<T, TResult>(Func<T, TResult>)

Overloaded. Projects each element of a sequence into a new form.(Defined by Enumerable.)

System_CAPS_pubmethodSelect<T, TResult>(Func<T, Int32, TResult>)

Overloaded. Projects each element of a sequence into a new form by incorporating the element's index.(Defined by Enumerable.)

System_CAPS_pubmethodSelectMany<T, TResult>(Func<T, IEnumerable<TResult>>)

Overloaded. Projects each element of a sequence to an IEnumerable<T> and flattens the resulting sequences into one sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSelectMany<T, TResult>(Func<T, Int32, IEnumerable<TResult>>)

Overloaded. Projects each element of a sequence to an IEnumerable<T>, and flattens the resulting sequences into one sequence. The index of each source element is used in the projected form of that element.(Defined by Enumerable.)

System_CAPS_pubmethodSelectMany<T, TCollection, TResult>(Func<T, IEnumerable<TCollection>>, Func<T, TCollection, TResult>)

Overloaded. Projects each element of a sequence to an IEnumerable<T>, flattens the resulting sequences into one sequence, and invokes a result selector function on each element therein.(Defined by Enumerable.)

System_CAPS_pubmethodSelectMany<T, TCollection, TResult>(Func<T, Int32, IEnumerable<TCollection>>, Func<T, TCollection, TResult>)

Overloaded. Projects each element of a sequence to an IEnumerable<T>, flattens the resulting sequences into one sequence, and invokes a result selector function on each element therein. The index of each source element is used in the intermediate projected form of that element.(Defined by Enumerable.)

System_CAPS_pubmethodSequenceEqual<T>(IEnumerable<T>)

Overloaded. Determines whether two sequences are equal by comparing the elements by using the default equality comparer for their type.(Defined by Enumerable.)

System_CAPS_pubmethodSequenceEqual<T>(IEnumerable<T>, IEqualityComparer<T>)

Overloaded. Determines whether two sequences are equal by comparing their elements by using a specified IEqualityComparer<T>.(Defined by Enumerable.)

System_CAPS_pubmethodSingle<T>()

Overloaded. Returns the only element of a sequence, and throws an exception if there is not exactly one element in the sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSingle<T>(Func<T, Boolean>)

Overloaded. Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists.(Defined by Enumerable.)

System_CAPS_pubmethodSingleOrDefault<T>()

Overloaded. Returns the only element of a sequence, or a default value if the sequence is empty; this method throws an exception if there is more than one element in the sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSingleOrDefault<T>(Func<T, Boolean>)

Overloaded. Returns the only element of a sequence that satisfies a specified condition or a default value if no such element exists; this method throws an exception if more than one element satisfies the condition.(Defined by Enumerable.)

System_CAPS_pubmethodSkip<T>(Int32)

Bypasses a specified number of elements in a sequence and then returns the remaining elements.(Defined by Enumerable.)

System_CAPS_pubmethodSkipWhile<T>(Func<T, Boolean>)

Overloaded. Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements.(Defined by Enumerable.)

System_CAPS_pubmethodSkipWhile<T>(Func<T, Int32, Boolean>)

Overloaded. Bypasses elements in a sequence as long as a specified condition is true and then returns the remaining elements. The element's index is used in the logic of the predicate function.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Decimal>)

Overloaded. Computes the sum of the sequence of Decimal values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Double>)

Overloaded. Computes the sum of the sequence of Double values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Int32>)

Overloaded. Computes the sum of the sequence of Int32 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Int64>)

Overloaded. Computes the sum of the sequence of Int64 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Nullable<Decimal>>)

Overloaded. Computes the sum of the sequence of nullable Decimal values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Nullable<Double>>)

Overloaded. Computes the sum of the sequence of nullable Double values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Nullable<Int32>>)

Overloaded. Computes the sum of the sequence of nullable Int32 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Nullable<Int64>>)

Overloaded. Computes the sum of the sequence of nullable Int64 values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Nullable<Single>>)

Overloaded. Computes the sum of the sequence of nullable Single values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodSum<T>(Func<T, Single>)

Overloaded. Computes the sum of the sequence of Single values that are obtained by invoking a transform function on each element of the input sequence.(Defined by Enumerable.)

System_CAPS_pubmethodTake<T>(Int32)

Returns a specified number of contiguous elements from the start of a sequence.(Defined by Enumerable.)

System_CAPS_pubmethodTakeWhile<T>(Func<T, Boolean>)

Overloaded. Returns elements from a sequence as long as a specified condition is true.(Defined by Enumerable.)

System_CAPS_pubmethodTakeWhile<T>(Func<T, Int32, Boolean>)

Overloaded. Returns elements from a sequence as long as a specified condition is true. The element's index is used in the logic of the predicate function.(Defined by Enumerable.)

System_CAPS_pubmethodToArray<T>()

Creates an array from a IEnumerable<T>.(Defined by Enumerable.)

System_CAPS_pubmethodToDictionary<T, TKey>(Func<T, TKey>)

Overloaded. Creates a Dictionary<TKey, TValue> from an IEnumerable<T> according to a specified key selector function.(Defined by Enumerable.)

System_CAPS_pubmethodToDictionary<T, TKey>(Func<T, TKey>, IEqualityComparer<TKey>)

Overloaded. Creates a Dictionary<TKey, TValue> from an IEnumerable<T> according to a specified key selector function and key comparer.(Defined by Enumerable.)

System_CAPS_pubmethodToDictionary<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>)

Overloaded. Creates a Dictionary<TKey, TValue> from an IEnumerable<T> according to specified key selector and element selector functions.(Defined by Enumerable.)

System_CAPS_pubmethodToDictionary<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>)

Overloaded. Creates a Dictionary<TKey, TValue> from an IEnumerable<T> according to a specified key selector function, a comparer, and an element selector function.(Defined by Enumerable.)

System_CAPS_pubmethodToList<T>()

Creates a List<T> from an IEnumerable<T>.(Defined by Enumerable.)

System_CAPS_pubmethodToLookup<T, TKey>(Func<T, TKey>)

Overloaded. Creates a Lookup<TKey, TElement> from an IEnumerable<T> according to a specified key selector function.(Defined by Enumerable.)

System_CAPS_pubmethodToLookup<T, TKey>(Func<T, TKey>, IEqualityComparer<TKey>)

Overloaded. Creates a Lookup<TKey, TElement> from an IEnumerable<T> according to a specified key selector function and key comparer.(Defined by Enumerable.)

System_CAPS_pubmethodToLookup<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>)

Overloaded. Creates a Lookup<TKey, TElement> from an IEnumerable<T> according to specified key selector and element selector functions.(Defined by Enumerable.)

System_CAPS_pubmethodToLookup<T, TKey, TElement>(Func<T, TKey>, Func<T, TElement>, IEqualityComparer<TKey>)

Overloaded. Creates a Lookup<TKey, TElement> from an IEnumerable<T> according to a specified key selector function, a comparer and an element selector function.(Defined by Enumerable.)

System_CAPS_pubmethodUnion<T>(IEnumerable<T>)

Overloaded. Produces the set union of two sequences by using the default equality comparer.(Defined by Enumerable.)

System_CAPS_pubmethodUnion<T>(IEnumerable<T>, IEqualityComparer<T>)

Overloaded. Produces the set union of two sequences by using a specified IEqualityComparer<T>.(Defined by Enumerable.)

System_CAPS_pubmethodWhere<T>(Func<T, Boolean>)

Overloaded. Filters a sequence of values based on a predicate.(Defined by Enumerable.)

System_CAPS_pubmethodWhere<T>(Func<T, Int32, Boolean>)

Overloaded. Filters a sequence of values based on a predicate. Each element's index is used in the logic of the predicate function.(Defined by Enumerable.)

System_CAPS_pubmethodZip<T, TSecond, TResult>(IEnumerable<TSecond>, Func<T, TSecond, TResult>)

Applies a specified function to the corresponding elements of two sequences, producing a sequence of the results.(Defined by Enumerable.)

BlockingCollection<T> is a thread-safe collection class that provides the following:

  • An implementation of the producer/consumer pattern; BlockingCollection<T> is a wrapper for the IProducerConsumerCollection<T> interface.

  • Concurrent addition and removal of items from multiple threads with the Add and Take methods.

  • A bounded collection that blocks Add and Take operations when the collection is full or empty.

  • Cancellation of Add or Take operations by using a CancellationToken object in the TryAdd or TryTake method.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic. Also, note that the Dispose() method is not thread-safe. All other public and protected members of BlockingCollection<T> are thread-safe and may be used concurrently from multiple threads.

IProducerConsumerCollection<T> represents a collection that allows for thread-safe adding and removal of data. BlockingCollection<T> is used as a wrapper for an IProducerConsumerCollection<T> instance, and allows removal attempts from the collection to block until data is available to be removed. Similarly, you can create a BlockingCollection<T> to enforce an upper bound on the number of data elements allowed in the IProducerConsumerCollection<T>; addition attempts to the collection may then block until space is available to store the added items. In this manner, BlockingCollection<T> is similar to a traditional blocking queue data structure, except that the underlying data storage mechanism is abstracted away as an IProducerConsumerCollection<T>.

BlockingCollection<T> supports bounding and blocking. Bounding means that you can set the maximum capacity of the collection. Bounding is important in certain scenarios because it enables you to control the maximum size of the collection in memory, and it prevents the producing threads from moving too far ahead of the consuming threads.Multiple threads or tasks can add items to the collection concurrently, and if the collection reaches its specified maximum capacity, the producing threads will block until an item is removed. Multiple consumers can remove items concurrently, and if the collection becomes empty, the consuming threads will block until a producer adds an item. A producing thread can call the CompleteAdding method to indicate that no more items will be added. Consumers monitor the IsCompleted property to know when the collection is empty and no more items will be added.

Add and Take operations are typically performed in a loop. You can cancel a loop by passing in a CancellationToken object to the TryAdd or TryTake method, and then checking the value of the token's IsCancellationRequested property on each iteration. If the value is true, it is up to you to respond the cancellation request by cleaning up any resources and exiting the loop.

When you create a BlockingCollection<T> object, you can specify not only the bounded capacity but also the type of collection to use. For example, you could specify a ConcurrentQueue<T> object for first in, first out (FIFO) behavior, or a ConcurrentStack<T> object for last in, first out (LIFO) behavior. You can use any collection class that implements the IProducerConsumerCollection<T> interface. The default collection type for BlockingCollection<T> is ConcurrentQueue<T>.

Do not modify the underlying collection directly. Use BlockingCollection<T> methods to add or remove elements. The BlockingCollection<T> object can become corrupted if you change the underlying collection directly.

The following example shows how to add and take items concurrently from a blocking collection:

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Concurrent;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

class BlockingCollectionDemo
{
    static void Main()
    {
        AddTakeDemo.BC_AddTakeCompleteAdding();
        TryTakeDemo.BC_TryTake();
        FromToAnyDemo.BC_FromToAny();
        ConsumingEnumerableDemo.BC_GetConsumingEnumerable();
        Console.WriteLine("Press any key to exit.");
        Console.ReadKey();
    }
}
class AddTakeDemo
{
    // Demonstrates:
    //      BlockingCollection<T>.Add()
    //      BlockingCollection<T>.Take()
    //      BlockingCollection<T>.CompleteAdding()
    public static void BC_AddTakeCompleteAdding()
    {
        using (BlockingCollection<int> bc = new BlockingCollection<int>())
        {

            // Spin up a Task to populate the BlockingCollection 
            using (Task t1 = Task.Factory.StartNew(() =>
            {
                bc.Add(1);
                bc.Add(2);
                bc.Add(3);
                bc.CompleteAdding();
            }))
            {

                // Spin up a Task to consume the BlockingCollection
                using (Task t2 = Task.Factory.StartNew(() =>
                {
                    try
                    {
                        // Consume consume the BlockingCollection
                        while (true) Console.WriteLine(bc.Take());
                    }
                    catch (InvalidOperationException)
                    {
                        // An InvalidOperationException means that Take() was called on a completed collection
                        Console.WriteLine("That's All!");
                    }
                }))

                    Task.WaitAll(t1, t2);
            }
        }
    }
}

class TryTakeDemo
{
    // Demonstrates:
    //      BlockingCollection<T>.Add()
    //      BlockingCollection<T>.CompleteAdding()
    //      BlockingCollection<T>.TryTake()
    //      BlockingCollection<T>.IsCompleted
    public static void BC_TryTake()
    {
        // Construct and fill our BlockingCollection
        using (BlockingCollection<int> bc = new BlockingCollection<int>())
        {
            int NUMITEMS = 10000;
            for (int i = 0; i < NUMITEMS; i++) bc.Add(i);
            bc.CompleteAdding();
            int outerSum = 0;

            // Delegate for consuming the BlockingCollection and adding up all items
            Action action = () =>
            {
                int localItem;
                int localSum = 0;

                while (bc.TryTake(out localItem)) localSum += localItem;
                Interlocked.Add(ref outerSum, localSum);
            };

            // Launch three parallel actions to consume the BlockingCollection
            Parallel.Invoke(action, action, action);

            Console.WriteLine("Sum[0..{0}) = {1}, should be {2}", NUMITEMS, outerSum, ((NUMITEMS*(NUMITEMS - 1))/2));
            Console.WriteLine("bc.IsCompleted = {0} (should be true)", bc.IsCompleted);
        }
    }
}

class FromToAnyDemo
{

    // Demonstrates:
    //      Bounded BlockingCollection<T>
    //      BlockingCollection<T>.TryAddToAny()
    //      BlockingCollection<T>.TryTakeFromAny()
    public static void BC_FromToAny()
    {
        BlockingCollection<int>[] bcs = new BlockingCollection<int>[2];
        bcs[0] = new BlockingCollection<int>(5); // collection bounded to 5 items
        bcs[1] = new BlockingCollection<int>(5); // collection bounded to 5 items

        // Should be able to add 10 items w/o blocking
        int numFailures = 0;
        for (int i = 0; i < 10; i++)
        {
            if (BlockingCollection<int>.TryAddToAny(bcs, i) == -1) numFailures++;
        }
        Console.WriteLine("TryAddToAny: {0} failures (should be 0)", numFailures);

        // Should be able to retrieve 10 items
        int numItems = 0;
        int item;
        while (BlockingCollection<int>.TryTakeFromAny(bcs, out item) != -1) numItems++;
        Console.WriteLine("TryTakeFromAny: retrieved {0} items (should be 10)", numItems);
    }
}

class ConsumingEnumerableDemo
{
    // Demonstrates:
    //      BlockingCollection<T>.Add()
    //      BlockingCollection<T>.CompleteAdding()
    //      BlockingCollection<T>.GetConsumingEnumerable()
    public static void BC_GetConsumingEnumerable()
    {
        using (BlockingCollection<int> bc = new BlockingCollection<int>())
        {

            // Kick off a producer task
            Task.Factory.StartNew(() =>
            {
                for (int i = 0; i < 10; i++)
                {
                    bc.Add(i);
                    Thread.Sleep(100); // sleep 100 ms between adds
                }

                // Need to do this to keep foreach below from hanging
                bc.CompleteAdding();
            });

            // Now consume the blocking collection with foreach.
            // Use bc.GetConsumingEnumerable() instead of just bc because the
            // former will block waiting for completion and the latter will
            // simply take a snapshot of the current state of the underlying collection.
            foreach (var item in bc.GetConsumingEnumerable())
            {
                Console.WriteLine(item);
            }
        }
    }
}

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1

The Dispose method is not thread-safe. All other public and protected members of BlockingCollection<T> are thread-safe and may be used concurrently from multiple threads.

Return to top
Show:
© 2016 Microsoft