BlockingCollection<T>.TryTakeFromAny Метод

Ссылка

Определение

Пространство имен:: System.Collections.Concurrent

Сборка:: System.Collections.Concurrent.dll

Сборка:: System.dll

Сборка:: netstandard.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)

Исходный код:: 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 больше, чем максимальный размер (62 для STA и 63 для MTA).

ArgumentException

Аргумент collections представляет собой массив нулевой длины или содержит элемент 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<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 больше, чем максимальный размер (62 для STA и 63 для MTA).

ArgumentException

Аргумент collections представляет собой массив нулевой длины или содержит элемент null.

InvalidOperationException

Хотя бы одна из базовых коллекций была изменена за пределами ее экземпляра BlockingCollection<T>.

См. также раздел

Применяется к

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 больше, чем максимальный размер (62 для STA и 63 для MTA).

ArgumentException

Аргумент collections представляет собой массив нулевой длины или содержит элемент null.

ObjectDisposedException

Хотя бы один из экземпляров BlockingCollection<T> был удален.

См. также раздел

Применяется к

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 больше, чем максимальный размер (62 для STA и 63 для MTA).

ArgumentException

Аргумент collections представляет собой массив нулевой длины или содержит элемент null.

InvalidOperationException

Хотя бы одна из базовых коллекций была изменена за пределами ее экземпляра BlockingCollection<T>.

См. также раздел

Применяется к

Поделиться через

BlockingCollection<T>.TryTakeFromAny Метод

Определение

Перегрузки

TryTakeFromAny(BlockingCollection<T>[], T)

Параметры

Возвращаемое значение

Исключения

Примеры

Комментарии

См. также раздел

Применяется к

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

Параметры

Возвращаемое значение

Исключения

Комментарии

См. также раздел

Применяется к

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

Параметры

Возвращаемое значение

Исключения

Комментарии

См. также раздел

Применяется к

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

Параметры

Возвращаемое значение

Исключения

Комментарии

См. также раздел

Применяется к

Дополнительные ресурсы