BlockingCollection<T>.Take Method (CancellationToken)

.NET Framework (current version)
 

Removes an item from the BlockingCollection<T>.

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

public T Take(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

Object that can be used to cancel the take operation.

Return Value

Type: T

The item removed from the collection.

Exception Condition
OperationCanceledException

The CancellationToken is canceled.

ObjectDisposedException

The BlockingCollection<T> has been disposed or the CancellationTokenSource that created the token was canceled.

InvalidOperationException

The underlying collection was modified outside of this BlockingCollection<T> instance or the BlockingCollection is marked as complete for adding, or the BlockingCollection<T> is empty.

A call to Take may block until an item is available to be removed or the token is canceled.

The order in which an item is removed depends on the type of collection used to create the BlockingCollection<T> instance. When you create a BlockingCollection<T> object, you can specify 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>.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: