BlockingCollection<T>.TryTakeFromAny Método

Definição

Namespace:

System.Collections.Concurrent

Assembly:

System.Collections.Concurrent.dll

Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

Sobrecargas

TryTakeFromAny(BlockingCollection<T>[], T)	Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.
TryTakeFromAny(BlockingCollection<T>[], T, Int32)	Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.
TryTakeFromAny(BlockingCollection<T>[], T, Int32, CancellationToken)	Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.
TryTakeFromAny(BlockingCollection<T>[], T, TimeSpan)	Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

TryTakeFromAny(BlockingCollection<T>[], T)

Origem:

BlockingCollection.cs

Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

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

Parâmetros

collections

BlockingCollection<T>[]

A matriz de coleções.

item

T

O item que foi removido de uma das coleções.

Retornos

Int32

O índice da coleção na matriz collections da qual o item foi removido ou -1 caso um item não possa ser removido.

Exceções

ObjectDisposedException

Pelo menos uma das instâncias de BlockingCollection<T> foi descartada.

ArgumentNullException

O argumento collections é nulo.

ArgumentOutOfRangeException

A contagem de collections é maior que o tamanho máximo de 62 para STA e 63 para MTA.

ArgumentException

O argumento collections é uma matriz de tamanho 0 ou contém um elemento nulo.

InvalidOperationException

Pelo menos uma das coleções subjacentes foi alterada fora da instância de BlockingCollection<T>.

Exemplos

O seguinte exemplo mostra como usar o método 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

Comentários

Uma chamada para TryTakeFromAny pode ser bloqueada até que um item esteja disponível para ser removido.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

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

Origem:

BlockingCollection.cs

Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

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

Parâmetros

collections

BlockingCollection<T>[]

A matriz de coleções da qual remover um item.

item

T

O item que foi removido de uma das coleções.

millisecondsTimeout

Int32

O número de milissegundos a aguardar a remoção do item ou Infinite (-1) aguardar indefinidamente.

Retornos

Int32

O índice da coleção na matriz collections da qual o item foi removido ou -1 caso um item não possa ser removido.

Exceções

ObjectDisposedException

Pelo menos uma das instâncias de BlockingCollection<T> foi descartada.

ArgumentNullException

O argumento collections é nulo.

ArgumentOutOfRangeException

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.

- ou -

A contagem de collections é maior que o tamanho máximo de 62 para STA e 63 para MTA.

ArgumentException

O argumento collections é uma matriz de tamanho 0 ou contém um elemento nulo.

InvalidOperationException

Pelo menos uma das coleções subjacentes foi alterada fora da instância de BlockingCollection<T>.

Comentários

Uma chamada para TryTakeFromAny pode ser bloqueada até que um item esteja disponível para ser removido.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

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

Origem:

BlockingCollection.cs

Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

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

Parâmetros

collections

BlockingCollection<T>[]

A matriz de coleções da qual remover um item.

item

T

O item que foi removido de uma das coleções.

millisecondsTimeout

Int32

O número de milissegundos a aguardar a remoção do item ou Infinite (-1) aguardar indefinidamente.

cancellationToken

CancellationToken

Um token de cancelamento a ser observado.

Retornos

Int32

O índice da coleção na matriz collections da qual o item foi removido ou -1 caso um item não possa ser removido.

Exceções

OperationCanceledException

O CancellationToken está cancelado.

InvalidOperationException

Pelo menos uma das coleções subjacentes foi alterada fora da instância de BlockingCollection<T>.

ArgumentNullException

O argumento collections é nulo.

ArgumentOutOfRangeException

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.

- ou -

A contagem de collections é maior que o tamanho máximo de 62 para STA e 63 para MTA.

ArgumentException

O argumento collections é uma matriz de tamanho 0 ou contém um elemento nulo.

ObjectDisposedException

Pelo menos uma das instâncias de BlockingCollection<T> foi descartada.

Comentários

Uma chamada para TryTakeFromAny pode ser bloqueada até que um item esteja disponível para ser removido.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

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

Origem:

BlockingCollection.cs

Tenta remover um item de qualquer uma das instâncias BlockingCollection<T> especificadas.

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

Parâmetros

collections

BlockingCollection<T>[]

A matriz de coleções.

item

T

O item que foi removido de uma das coleções.

timeout

TimeSpan

Um TimeSpan que representa o número de milissegundos para aguardar ou um TimeSpan que representa -1 milissegundos para aguardar indefinidamente.

Retornos

Int32

O índice da coleção na matriz collections da qual o item foi removido ou -1 caso um item não possa ser removido.

Exceções

ObjectDisposedException

Pelo menos uma das instâncias de BlockingCollection<T> foi descartada.

ArgumentNullException

O argumento collections é nulo.

ArgumentOutOfRangeException

timeout é um número negativo diferente de -1 milissegundos, que representa um tempo limite infinito

-ou-

timeout é maior que Int32.MaxValue.

- ou -

A contagem de collections é maior que o tamanho máximo de 62 para STA e 63 para MTA.

ArgumentException

O argumento collections é uma matriz de tamanho 0 ou contém um elemento nulo.

InvalidOperationException

Pelo menos uma das coleções subjacentes foi alterada fora da instância de BlockingCollection<T>.

Comentários

Uma chamada para TryTakeFromAny pode ser bloqueada até que um item esteja disponível para ser removido.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection