BlockingCollection<T>.Take メソッド

定義

名前空間:

System.Collections.Concurrent

アセンブリ:

System.Collections.Concurrent.dll

BlockingCollection<T> から項目を削除します。

オーバーロード

Take()	BlockingCollection<T> から項目を削除します。
Take(CancellationToken)	BlockingCollection<T> から項目を削除します。

Take()

ソース:

BlockingCollection.cs

BlockingCollection<T> から項目を削除します。

public:
 T Take();

public T Take ();

member this.Take : unit -> 'T

Public Function Take () As T

戻り値

T

コレクションから削除された項目。

例外

ObjectDisposedException

BlockingCollection<T> は破棄されています。

InvalidOperationException

基になるコレクションがこの BlockingCollection<T> インスタンスの外部で変更されたか、 BlockingCollection<T> が空で、追加に関して完了としてマークされています。

注釈

を Take 呼び出すと、アイテムを削除できるようになるまでブロックされる場合があります。

項目が削除される順序は、BlockingCollection<T> インスタンスの作成に使用されたコレクションの型によって異なります。 BlockingCollection<T> オブジェクトを作成すると、使用するコレクションの型を指定できます。 たとえば、先入れ先出し法 (FIFO) の動作には ConcurrentQueue<T> オブジェクトを指定し、後入れ先出し法 (LIFO) の動作には ConcurrentStack<T> オブジェクトを指定できます。 IProducerConsumerCollection<T> インターフェイスを実装する任意のコレクション クラスを使用できます。 BlockingCollection<T> の既定のコレクション型は ConcurrentQueue<T> です。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要

Take(CancellationToken)

ソース:

BlockingCollection.cs

BlockingCollection<T> から項目を削除します。

public:
 T Take(System::Threading::CancellationToken cancellationToken);

public T Take (System.Threading.CancellationToken cancellationToken);

member this.Take : System.Threading.CancellationToken -> 'T

Public Function Take (cancellationToken As CancellationToken) As T

パラメーター

cancellationToken

CancellationToken

"take" 操作を取り消すために使用できるトークン。

戻り値

T

コレクションから削除された項目。

例外

OperationCanceledException

CancellationToken は取り消されます。

ObjectDisposedException

BlockingCollection<T> は破棄されています。

InvalidOperationException

基になるコレクションがこの BlockingCollection<T> インスタンスの外部で変更されたか、 BlockingCollection<T> が空で、追加に関して完了としてマークされています。

注釈

の Take 呼び出しは、アイテムを削除できるようになるか、トークンが取り消されるまでブロックできます。

項目が削除される順序は、BlockingCollection<T> インスタンスの作成に使用されたコレクションの型によって異なります。 BlockingCollection<T> オブジェクトを作成すると、使用するコレクションの型を指定できます。 たとえば、先入れ先出し法 (FIFO) の動作には ConcurrentQueue<T> オブジェクトを指定し、後入れ先出し法 (LIFO) の動作には ConcurrentStack<T> オブジェクトを指定できます。 IProducerConsumerCollection<T> インターフェイスを実装する任意のコレクション クラスを使用できます。 BlockingCollection<T> の既定のコレクション型は ConcurrentQueue<T> です。

こちらもご覧ください

• スレッドセーフなコレクション
• BlockingCollection の概要