BlockingCollection<T>.TryTakeFromAny 方法

定义

命名空间:

System.Collections.Concurrent

程序集:

System.Collections.Concurrent.dll

尝试从任一指定的 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)

Source:

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);

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 的调用可能会阻止，直到某个项可供删除。

另请参阅

• 线程安全集合
• BlockingCollection 概述

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

Source:

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);

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 的负数，而 -1 表示无限期超时。

- 或 -

collections 的计数大于上限（STA 为 62，MTA 为 63）。

ArgumentException

collections 参数是一个长度为 0 的数组，或包含 NULL 元素。

InvalidOperationException

至少一个基础集合已在其 BlockingCollection<T> 实例之外进行了修改。

注解

对 TryTakeFromAny 的调用可能会阻止，直到某个项可供删除。

另请参阅

• 线程安全集合
• BlockingCollection 概述

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

Source:

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);

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 的负数，而 -1 表示无限期超时。

- 或 -

collections 的计数大于上限（STA 为 62，MTA 为 63）。

ArgumentException

collections 参数是一个长度为 0 的数组，或包含 NULL 元素。

ObjectDisposedException

至少已释放其中一个 BlockingCollection<T> 实例。

注解

对 TryTakeFromAny 的调用可能会阻止，直到某个项可供删除。

另请参阅

• 线程安全集合
• BlockingCollection 概述

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

Source:

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);

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，或表示 -1 毫秒（无限期等待）的 TimeSpan。

返回

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 概述