BlockingCollection<T>.Take BlockingCollection<T>.Take BlockingCollection<T>.Take BlockingCollection<T>.Take Method

Definition

Removes an item from the BlockingCollection<T>.

Overloads

Take() Take() Take() Take()

Removes an item from the BlockingCollection<T>.

Take(CancellationToken) Take(CancellationToken) Take(CancellationToken)

Removes an item from the BlockingCollection<T>.

Take() Take() Take() Take()

Removes an item from the BlockingCollection<T>.

public:
 T Take();
public T Take ();
member this.Take : unit -> 'T
Public Function Take () As T
Returns

The item removed from the collection.

Exceptions

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

Remarks

A call to Take may block until an item is available to be removed.

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>.

Take(CancellationToken) Take(CancellationToken) Take(CancellationToken)

Removes an item from the BlockingCollection<T>.

public:
 T Take(System::Threading::CancellationToken cancellationToken);
public T Take (System.Threading.CancellationToken cancellationToken);
member this.Take : System.Threading.CancellationToken -> 'T
Parameters
cancellationToken
CancellationToken CancellationToken CancellationToken CancellationToken

Object that can be used to cancel the take operation.

Returns

The item removed from the collection.

Exceptions

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.

Remarks

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>.

Applies to