BlockingCollection<T>.TryTakeFromAny 方法

參考

定義

命名空間:: System.Collections.Concurrent

組件:: System.Collections.Concurrent.dll

組件:: System.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

嘗試從任何一個指定的 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<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

已從其中一個集合中移除的專案。

傳回

Int32

所移除之項目所在的 collections 陣列中集合的索引，如果無法移除項目則為 -1。

例外狀況

ObjectDisposedException

至少其中一個 BlockingCollection<T> 執行個體已經處置。

ArgumentNullException

collections 引數為 null。

ArgumentOutOfRangeException

collections 的計數大於 STA 的上限 62 和 MTA 的上限 63。

ArgumentException

collections 引數是長度為 0 的陣列，或包含 Null 項目。

InvalidOperationException

至少其中一個基礎集合已在其 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<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

已從其中一個集合中移除的專案。

millisecondsTimeout: Int32

等候移除專案的毫秒數，或 Infinite (-1) 無限期等候。

傳回

Int32

所移除之項目所在的 collections 陣列中集合的索引，如果無法移除項目則為 -1。

例外狀況

ObjectDisposedException

至少其中一個 BlockingCollection<T> 執行個體已經處置。

ArgumentNullException

collections 引數為 null。

ArgumentOutOfRangeException

millisecondsTimeout 為 -1 以外的負數，表示無限逾時。

-或-

collections 的計數大於 STA 的上限 62 和 MTA 的上限 63。

ArgumentException

collections 引數是長度為 0 的陣列，或包含 Null 項目。

InvalidOperationException

至少其中一個基礎集合已在其 BlockingCollection<T> 執行個體外修改。

備註

對 TryTakeFromAny 的呼叫可能會封鎖，直到專案可供移除為止。

另請參閱

適用於

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

來源:: 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

已從其中一個集合中移除的專案。

millisecondsTimeout: Int32

等候移除專案的毫秒數，或 Infinite (-1) 無限期等候。

cancellationToken: CancellationToken

要觀察的取消語彙基元。

傳回

Int32

所移除之項目所在的 collections 陣列中集合的索引，如果無法移除項目則為 -1。

例外狀況

OperationCanceledException

CancellationToken 已取消。

InvalidOperationException

至少其中一個基礎集合已在其 BlockingCollection<T> 執行個體外修改。

ArgumentNullException

collections 引數為 null。

ArgumentOutOfRangeException

millisecondsTimeout 為 -1 以外的負數，表示無限逾時。

-或-

collections 的計數大於 STA 的上限 62 和 MTA 的上限 63。

ArgumentException

collections 引數是長度為 0 的陣列，或包含 Null 項目。

ObjectDisposedException

至少其中一個 BlockingCollection<T> 執行個體已經處置。

備註

對 TryTakeFromAny 的呼叫可能會封鎖，直到專案可供移除為止。

另請參閱

適用於

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

來源:: 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

已從其中一個集合中移除的專案。

timeout: TimeSpan

TimeSpan，代表等候毫秒數；或是 TimeSpan，代表無限期等候的 -1 毫秒。

傳回

Int32

所移除之項目所在的 collections 陣列中集合的索引，如果無法移除項目則為 -1。

例外狀況

ObjectDisposedException

至少其中一個 BlockingCollection<T> 執行個體已經處置。

ArgumentNullException

collections 引數為 null。

ArgumentOutOfRangeException

timeout 是 -1 毫秒以外的負數，表示無限逾時

-或-

timeout 大於 Int32.MaxValue。

-或-

collections 的計數大於 STA 的上限 62 和 MTA 的上限 63。

ArgumentException

collections 引數是長度為 0 的陣列，或包含 Null 項目。

InvalidOperationException

至少其中一個基礎集合已在其 BlockingCollection<T> 執行個體外修改。

備註

對 TryTakeFromAny 的呼叫可能會封鎖，直到專案可供移除為止。

另請參閱

適用於

BlockingCollection<T>.TryTakeFromAny 方法

定義

多載

TryTakeFromAny(BlockingCollection<T>[], T)

參數

傳回

例外狀況

範例

備註

另請參閱

適用於

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

參數

傳回

例外狀況

備註

另請參閱

適用於

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

參數

傳回

例外狀況

備註

另請參閱

適用於

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

參數

傳回

例外狀況

備註

另請參閱

適用於

意見反應

其他資源