BlockingCollection<T>.TryTakeFromAny メソッド

定義

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

オーバーロード

名前 説明
TryTakeFromAny(BlockingCollection<T>[], T)

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

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

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

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

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

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

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

TryTakeFromAny(BlockingCollection<T>[], T)

ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

public:
 static int TryTakeFromAny(cli::array <System::Collections::Concurrent::BlockingCollection<T> ^> ^ collections, [Runtime::InteropServices::Out] T % item);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T? item);
static member TryTakeFromAny : System.Collections.Concurrent.BlockingCollection<'T>[] * 'T -> int
Public Shared Function TryTakeFromAny (collections As BlockingCollection(Of T)(), ByRef item As T) As Integer

パラメーター

collections
BlockingCollection<T>[]

コレクションの配列。

item
T

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

返品

項目が削除された collections 配列内のコレクションのインデックス。項目を削除できなかった場合は -1。

例外

少なくとも 1 つの BlockingCollection<T> インスタンスが破棄されました。

collections引数は null です。

collectionsの数が、STA の場合は最大サイズ 62、MTA の場合は 63 を超えています。

collections引数は、長さが 0 の配列であるか、null 要素を含みます。

基になるコレクションの少なくとも 1 つが、 BlockingCollection<T> インスタンスの外部で変更されました。

次の例は、 BlockingCollection<T>.TryTakeFromAny メソッドの使用方法を示しています。

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);
    }
}
module FromToAnyDemo =
    // Demonstrates:
    //      Bounded BlockingCollection<T>
    //      BlockingCollection<T>.TryAddToAny()
    //      BlockingCollection<T>.TryTakeFromAny()
    let blockingCollectionFromToAny () =
        let bcs = 
            [|
                new BlockingCollection<int>(5) // collection bounded to 5 items
                new BlockingCollection<int>(5) // collection bounded to 5 items
             |]
        // Should be able to add 10 items w/o blocking
        let mutable numFailures = 0;
        for i = 0 to 9 do
            if BlockingCollection<int>.TryAddToAny(bcs, i) = -1 then
                numFailures <- numFailures + 1
        printfn $"TryAddToAny: {numFailures} failures (should be 0)"

        // Should be able to retrieve 10 items
        let mutable numItems = 0
        let mutable item = 0
        while BlockingCollection<int>.TryTakeFromAny(bcs, &item) <> -1 do
            numItems <- numItems + 1
        printfn $"TryTakeFromAny: retrieved {numItems} items (should be 10)"
'Imports System.Threading.Tasks
'Imports System.Collections.Concurrent

' Demonstrates:
' Bounded BlockingCollection<T>
' BlockingCollection<T>.TryAddToAny()
' BlockingCollection<T>.TryTakeFromAny()
Class ToAnyDemo
    Shared Sub BC_ToAny()
        Dim bcs As BlockingCollection(Of Integer)() = New BlockingCollection(Of Integer)(1) {}
        bcs(0) = New BlockingCollection(Of Integer)(5)
        ' collection bounded to 5 items
        bcs(1) = New BlockingCollection(Of Integer)(5)
        ' collection bounded to 5 items
        ' Should be able to add 10 items w/o blocking
        Dim numFailures As Integer = 0
        For i As Integer = 0 To 9
            If BlockingCollection(Of Integer).TryAddToAny(bcs, i) = -1 Then
                numFailures += 1
            End If
        Next
        Console.WriteLine("TryAddToAny: {0} failures (should be 0)", numFailures)

        ' Should be able to retrieve 10 items
        Dim numItems As Integer = 0
        Dim item As Integer
        While BlockingCollection(Of Integer).TryTakeFromAny(bcs, item) <> -1
            numItems += 1
        End While
        Console.WriteLine("TryTakeFromAny: retrieved {0} items (should be 10)", numItems)
    End Sub
End Class

注釈

TryTakeFromAny の呼び出しは、項目を削除できるようになるまでブロックできます。

こちらもご覧ください

適用対象

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

ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

public:
 static int TryTakeFromAny(cli::array <System::Collections::Concurrent::BlockingCollection<T> ^> ^ collections, [Runtime::InteropServices::Out] T % item, int millisecondsTimeout);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, int millisecondsTimeout);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T? item, int millisecondsTimeout);
static member TryTakeFromAny : System.Collections.Concurrent.BlockingCollection<'T>[] * 'T * int -> int
Public Shared Function TryTakeFromAny (collections As BlockingCollection(Of T)(), ByRef item As T, millisecondsTimeout As Integer) As Integer

パラメーター

collections
BlockingCollection<T>[]

項目を削除するコレクションの配列。

item
T

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

millisecondsTimeout
Int32

項目が削除されるのを待機するミリ秒数。または無期限に待機する Infinite (-1)。

返品

項目が削除された collections 配列内のコレクションのインデックス。項目を削除できなかった場合は -1。

例外

少なくとも 1 つの BlockingCollection<T> インスタンスが破棄されました。

collections引数は null です。

millisecondsTimeout は-1 以外の負の数で、無限タイムアウトを表します。

-又は-

collectionsの数が、STA の場合は最大サイズ 62、MTA の場合は 63 を超えています。

collections引数は、長さが 0 の配列であるか、null 要素を含みます。

基になるコレクションの少なくとも 1 つが、 BlockingCollection<T> インスタンスの外部で変更されました。

注釈

TryTakeFromAny の呼び出しは、項目を削除できるようになるまでブロックできます。

こちらもご覧ください

適用対象

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

ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

public:
 static int TryTakeFromAny(cli::array <System::Collections::Concurrent::BlockingCollection<T> ^> ^ collections, [Runtime::InteropServices::Out] T % item, int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T? item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);
static member TryTakeFromAny : System.Collections.Concurrent.BlockingCollection<'T>[] * 'T * int * System.Threading.CancellationToken -> int
Public Shared Function TryTakeFromAny (collections As BlockingCollection(Of T)(), ByRef item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Integer

パラメーター

collections
BlockingCollection<T>[]

項目を削除するコレクションの配列。

item
T

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

millisecondsTimeout
Int32

項目が削除されるのを待機するミリ秒数。または無期限に待機する Infinite (-1)。

cancellationToken
CancellationToken

観察するキャンセル トークン。

返品

項目が削除された collections 配列内のコレクションのインデックス。項目を削除できなかった場合は -1。

例外

CancellationTokenは取り消されます。

基になるコレクションの少なくとも 1 つが、 BlockingCollection<T> インスタンスの外部で変更されました。

collections引数は null です。

millisecondsTimeout は-1 以外の負の数で、無限タイムアウトを表します。

-又は-

collectionsの数が、STA の場合は最大サイズ 62、MTA の場合は 63 を超えています。

collections引数は、長さが 0 の配列であるか、null 要素を含みます。

少なくとも 1 つの BlockingCollection<T> インスタンスが破棄されました。

注釈

TryTakeFromAny の呼び出しは、項目を削除できるようになるまでブロックできます。

こちらもご覧ください

適用対象

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

ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs
ソース:
BlockingCollection.cs

指定した BlockingCollection<T> インスタンスのいずれかから項目の削除を試みます。

public:
 static int TryTakeFromAny(cli::array <System::Collections::Concurrent::BlockingCollection<T> ^> ^ collections, [Runtime::InteropServices::Out] T % item, TimeSpan timeout);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, TimeSpan timeout);
public static int TryTakeFromAny(System.Collections.Concurrent.BlockingCollection<T>[] collections, out T? item, TimeSpan timeout);
static member TryTakeFromAny : System.Collections.Concurrent.BlockingCollection<'T>[] * 'T * TimeSpan -> int
Public Shared Function TryTakeFromAny (collections As BlockingCollection(Of T)(), ByRef item As T, timeout As TimeSpan) As Integer

パラメーター

collections
BlockingCollection<T>[]

コレクションの配列。

item
T

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

timeout
TimeSpan

待機するミリ秒数を表す TimeSpan 、または無期限に待機する -1 ミリ秒を表す TimeSpan

返品

項目が削除された collections 配列内のコレクションのインデックス。項目を削除できなかった場合は -1。

例外

少なくとも 1 つの BlockingCollection<T> インスタンスが破棄されました。

collections引数は null です。

timeout は、無限タイムアウトを表す -1 ミリ秒以外の負の数です。

-又は-

timeoutInt32.MaxValue より大きい。

-又は-

collectionsの数が、STA の場合は最大サイズ 62、MTA の場合は 63 を超えています。

collections引数は、長さが 0 の配列であるか、null 要素を含みます。

基になるコレクションの少なくとも 1 つが、 BlockingCollection<T> インスタンスの外部で変更されました。

注釈

TryTakeFromAny の呼び出しは、項目を削除できるようになるまでブロックできます。

こちらもご覧ください

適用対象