BlockingCollection<T>.TryTake Método

Referência

Definição

Namespace:: System.Collections.Concurrent

Assembly:: System.Collections.Concurrent.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Tenta remover um item no BlockingCollection<T>.

Sobrecargas

TryTake(T)	Tenta remover um item no BlockingCollection<T>.
TryTake(T, TimeSpan)	Tenta remover um item do BlockingCollection<T> no período de tempo especificado.
TryTake(T, Int32, CancellationToken)	Tenta remover um item do BlockingCollection<T> no período especificado, enquanto observa um token de cancelamento.
TryTake(T, Int32)	Tenta remover um item do BlockingCollection<T> no período de tempo especificado.

Exemplos

O exemplo a seguir mostra como usar o método TryTake.

class TryTakeDemo
{
    // Demonstrates:
    //      BlockingCollection<T>.Add()
    //      BlockingCollection<T>.CompleteAdding()
    //      BlockingCollection<T>.TryTake()
    //      BlockingCollection<T>.IsCompleted
    public static void BC_TryTake()
    {
        // Construct and fill our BlockingCollection
        using (BlockingCollection<int> bc = new BlockingCollection<int>())
        {
            int NUMITEMS = 10000;
            for (int i = 0; i < NUMITEMS; i++) bc.Add(i);
            bc.CompleteAdding();
            int outerSum = 0;

            // Delegate for consuming the BlockingCollection and adding up all items
            Action action = () =>
            {
                int localItem;
                int localSum = 0;

                while (bc.TryTake(out localItem)) localSum += localItem;
                Interlocked.Add(ref outerSum, localSum);
            };

            // Launch three parallel actions to consume the BlockingCollection
            Parallel.Invoke(action, action, action);

            Console.WriteLine("Sum[0..{0}) = {1}, should be {2}", NUMITEMS, outerSum, ((NUMITEMS * (NUMITEMS - 1)) / 2));
            Console.WriteLine("bc.IsCompleted = {0} (should be true)", bc.IsCompleted);
        }
    }
}

module TryTakeDemo =
    // Demonstrates:
    //      BlockingCollection<T>.Add()
    //      BlockingCollection<T>.CompleteAdding()
    //      BlockingCollection<T>.TryTake()
    //      BlockingCollection<T>.IsCompleted
    let blockingCollectionTryTake () =
        // Construct and fill our BlockingCollection
        use bc = new BlockingCollection<int>()
        let NUMITEMS = 10000;
        for i = 0 to NUMITEMS - 1 do
            bc.Add i
        bc.CompleteAdding()
        let mutable outerSum = 0

        // Delegate for consuming the BlockingCollection and adding up all items
        let action = 
            Action(fun () ->
                let mutable localItem = 0
                let mutable localSum = 0

                while bc.TryTake &localItem do
                    localSum <- localSum + localItem
                Interlocked.Add(&outerSum, localSum)
                |> ignore)

        // Launch three parallel actions to consume the BlockingCollection
        Parallel.Invoke(action, action, action)

        printfn $"Sum[0..{NUMITEMS}) = {outerSum}, should be {((NUMITEMS * (NUMITEMS - 1)) / 2)}"
        printfn $"bc.IsCompleted = {bc.IsCompleted} (should be true)"

'Imports System.Collections.Concurrent
'Imports System.Threading
'Imports System.Threading.Tasks

Class TryTakeDemo
    ' Demonstrates:
    ' BlockingCollection<T>.Add()
    ' BlockingCollection<T>.CompleteAdding()
    ' BlockingCollection<T>.TryTake()
    ' BlockingCollection<T>.IsCompleted
    Shared Sub BC_TryTake()
        ' Construct and fill our BlockingCollection
        Using bc As New BlockingCollection(Of Integer)()
            Dim NUMITEMS As Integer = 10000
            For i As Integer = 0 To NUMITEMS - 1
                bc.Add(i)
            Next
            bc.CompleteAdding()
            Dim outerSum As Integer = 0

            ' Delegate for consuming the BlockingCollection and adding up all items
            Dim action As Action =
                Sub()
                    Dim localItem As Integer
                    Dim localSum As Integer = 0

                    While bc.TryTake(localItem)
                        localSum += localItem
                    End While
                    Interlocked.Add(outerSum, localSum)
                End Sub

            ' Launch three parallel actions to consume the BlockingCollection
            Parallel.Invoke(action, action, action)

            Console.WriteLine("Sum[0..{0}) = {1}, should be {2}", NUMITEMS, outerSum, ((NUMITEMS * (NUMITEMS - 1)) / 2))
            Console.WriteLine("bc.IsCompleted = {0} (should be true)", bc.IsCompleted)
        End Using
    End Sub

End Class

TryTake(T)

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Tenta remover um item no BlockingCollection<T>.

public:
 bool TryTake([Runtime::InteropServices::Out] T % item);

public bool TryTake (out T item);

member this.TryTake : 'T -> bool

Public Function TryTake (ByRef item As T) As Boolean

Parâmetros

item: T

O item a ser removido da coleção.

Retornos

Boolean

true se um item pode ser removido; Caso contrário, false.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

InvalidOperationException

A coleção subjacente foi alterada fora da instância de BlockingCollection<T>.

Comentários

Se a coleção estiver vazia, esse método retornará imediatamente false.

A ordem na qual um item é removido depende do tipo de coleção usado para criar a instância BlockingCollection<T>. Ao criar um objeto BlockingCollection<T>, você pode especificar o tipo de coleção a ser usado. Por exemplo, seria possível especificar um objeto ConcurrentQueue<T> para o comportamento primeiro a entrar, primeiro a sair (PEPS) ou um objeto ConcurrentStack<T> para último a entrar, primeiro a sair (UEPS). Você pode usar qualquer classe de coleção que implemente a interface IProducerConsumerCollection<T>. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.

Confira também

Aplica-se a

TryTake(T, TimeSpan)

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Tenta remover um item do BlockingCollection<T> no período de tempo especificado.

public:
 bool TryTake([Runtime::InteropServices::Out] T % item, TimeSpan timeout);

public bool TryTake (out T item, TimeSpan timeout);

member this.TryTake : 'T * TimeSpan -> bool

Public Function TryTake (ByRef item As T, timeout As TimeSpan) As Boolean

Parâmetros

item: T

O item a ser removido da coleção.

timeout: TimeSpan

Um TimeSpan que representa o número de milissegundos a aguardar a remoção do item ou um TimeSpan que representa -1 milissegundos para aguardar indefinidamente.

Retornos

Boolean

true se um item puder ser removido da coleção dentro do tempo especificado; caso contrário, false.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

ArgumentOutOfRangeException

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

- ou -

timeout é maior que Int32.MaxValue.

InvalidOperationException

A coleção subjacente foi alterada fora da instância de BlockingCollection<T>.

Comentários

Confira também

Aplica-se a

TryTake(T, Int32, CancellationToken)

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Tenta remover um item do BlockingCollection<T> no período especificado, enquanto observa um token de cancelamento.

public:
 bool TryTake([Runtime::InteropServices::Out] T % item, int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);

public bool TryTake (out T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);

member this.TryTake : 'T * int * System.Threading.CancellationToken -> bool

Public Function TryTake (ByRef item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

Parâmetros

item: T

O item a ser removido da coleção.

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

Boolean

true se um item puder ser removido da coleção dentro do tempo especificado; caso contrário, false.

Exceções

OperationCanceledException

O CancellationToken foi cancelado.

ObjectDisposedException

O BlockingCollection<T> foi descartado ou o CancellationTokenSource subjacente foi descartado.

ArgumentOutOfRangeException

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

InvalidOperationException

A coleção subjacente foi alterada fora da dessa instância de BlockingCollection<T>.

Comentários

Confira também

Aplica-se a

TryTake(T, Int32)

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Origem:: BlockingCollection.cs

Tenta remover um item do BlockingCollection<T> no período de tempo especificado.

public:
 bool TryTake([Runtime::InteropServices::Out] T % item, int millisecondsTimeout);

public bool TryTake (out T item, int millisecondsTimeout);

member this.TryTake : 'T * int -> bool

Public Function TryTake (ByRef item As T, millisecondsTimeout As Integer) As Boolean

Parâmetros

item: T

O item a ser removido da coleção.

millisecondsTimeout: Int32

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

Retornos

Boolean

true se um item puder ser removido da coleção dentro do tempo especificado; caso contrário, false.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

ArgumentOutOfRangeException

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

InvalidOperationException

A coleção subjacente foi alterada fora da instância de BlockingCollection<T>.

Comentários

A ordem na qual um item é removido depende do tipo de coleção usado para criar a instância BlockingCollection<T>. Ao criar um BlockingCollection<T>, você pode especificar o tipo de coleção a ser usado. Por exemplo, seria possível especificar um objeto ConcurrentQueue<T> para o comportamento primeiro a entrar, primeiro a sair (PEPS) ou um objeto ConcurrentStack<T> para último a entrar, primeiro a sair (UEPS). Você pode usar qualquer classe de coleção que implemente a interface IProducerConsumerCollection<T>. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.

Confira também

Aplica-se a

Compartilhar via

BlockingCollection<T>.TryTake Método

Definição

Sobrecargas

Exemplos

TryTake(T)

Parâmetros

Retornos

Exceções

Comentários

Confira também

Aplica-se a

TryTake(T, TimeSpan)

Parâmetros

Retornos

Exceções

Comentários

Confira também

Aplica-se a

TryTake(T, Int32, CancellationToken)

Parâmetros

Retornos

Exceções

Comentários

Confira também

Aplica-se a

TryTake(T, Int32)

Parâmetros

Retornos

Exceções

Comentários

Confira também

Aplica-se a

Recursos adicionais