BlockingCollection<T>.TryTake Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Tenta remover um item do BlockingCollection<T>arquivo .
Sobrecargas
| Name | Description |
|---|---|
| TryTake(T) |
Tenta remover um item do BlockingCollection<T>arquivo . |
| TryTake(T, TimeSpan) |
Tenta remover um item dentro BlockingCollection<T> do período de tempo especificado. |
| TryTake(T, Int32, CancellationToken) |
Tenta remover um item do BlockingCollection<T> no período de tempo especificado enquanto observa um token de cancelamento. |
| TryTake(T, Int32) |
Tenta remover um item dentro BlockingCollection<T> do período de tempo especificado. |
Exemplos
O exemplo seguinte mostra como usar o TryTake método.
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)
Tenta remover um item do BlockingCollection<T>arquivo .
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.
Devoluções
true se um item pudesse ser removido; caso contrário, false.
Exceções
O BlockingCollection<T> foi descartado.
A coleção subjacente foi modificada fora desta BlockingCollection<T> instância.
Observações
Se a coleção estiver vazia, este método retorna imediatamente false.
A ordem em que um item é removido depende do tipo de coleção usada para criar a BlockingCollection<T> instância. Quando crias um BlockingCollection<T> objeto, podes especificar o tipo de coleção a usar. Por exemplo, pode especificar um ConcurrentQueue<T> objeto para comportamento de primeiro a entrar, primeiro a sair (FIFO), ou um ConcurrentStack<T> objeto para o comportamento de último a entrar, primeiro a sair (LIFO). Você pode usar qualquer classe de coleção que implemente a IProducerConsumerCollection<T> interface. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.
Ver também
Aplica-se a
TryTake(T, TimeSpan)
Tenta remover um item dentro BlockingCollection<T> do 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
A TimeSpan que representa o número de milissegundos para esperar que o item seja removido, ou a TimeSpan que representa -1 milissegundos para esperar indefinidamente.
Devoluções
true se um item pudesse ser removido da coleção dentro do prazo especificado; caso contrário, false.
Exceções
O BlockingCollection<T> foi descartado.
timeout é um número negativo diferente de -1 milissegundos, o que representa um tempo de espera infinito.
-ou-
timeout é maior do que Int32.MaxValue.
A coleção subjacente foi modificada fora desta BlockingCollection<T> instância.
Observações
A ordem em que um item é removido depende do tipo de coleção usada para criar a BlockingCollection<T> instância. Quando crias um BlockingCollection<T> objeto, podes especificar o tipo de coleção a usar. Por exemplo, pode especificar um ConcurrentQueue<T> objeto para comportamento de primeiro a entrar, primeiro a sair (FIFO), ou um ConcurrentStack<T> objeto para o comportamento de último a entrar, primeiro a sair (LIFO). Você pode usar qualquer classe de coleção que implemente a IProducerConsumerCollection<T> interface. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.
Ver também
Aplica-se a
TryTake(T, Int32, CancellationToken)
Tenta remover um item do BlockingCollection<T> no período de tempo 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 para esperar que o item seja removido, ou Infinite (-1) para esperar indefinidamente.
- cancellationToken
- CancellationToken
Um token de cancelamento para observar.
Devoluções
true se um item pudesse ser removido da coleção dentro do prazo especificado; caso contrário, false.
Exceções
Foi CancellationToken cancelado.
O BlockingCollection<T> subjacente foi eliminado ou o subjacente CancellationTokenSource foi descartado.
millisecondsTimeout é um número negativo diferente de -1, o que representa um tempo limite infinito.
A coleção subjacente foi modificada fora desta BlockingCollection<T> instância.
Observações
A ordem em que um item é removido depende do tipo de coleção usada para criar a BlockingCollection<T> instância. Quando crias um BlockingCollection<T> objeto, podes especificar o tipo de coleção a usar. Por exemplo, pode especificar um ConcurrentQueue<T> objeto para comportamento de primeiro a entrar, primeiro a sair (FIFO), ou um ConcurrentStack<T> objeto para o comportamento de último a entrar, primeiro a sair (LIFO). Você pode usar qualquer classe de coleção que implemente a IProducerConsumerCollection<T> interface. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.
Ver também
Aplica-se a
TryTake(T, Int32)
Tenta remover um item dentro BlockingCollection<T> do 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 para esperar que o item seja removido, ou Infinite (-1) para esperar indefinidamente.
Devoluções
true se um item pudesse ser removido da coleção dentro do prazo especificado; caso contrário, false.
Exceções
O BlockingCollection<T> foi descartado.
millisecondsTimeout é um número negativo diferente de -1, o que representa um tempo limite infinito.
A coleção subjacente foi modificada fora desta BlockingCollection<T> instância.
Observações
A ordem em que um item é removido depende do tipo de coleção usada para criar a BlockingCollection<T> instância. Quando cria um BlockingCollection<T>, pode especificar o tipo de coleção a utilizar. Por exemplo, pode especificar um ConcurrentQueue<T> objeto para comportamento de primeiro a entrar, primeiro a sair (FIFO), ou um ConcurrentStack<T> objeto para o comportamento de último a entrar, primeiro a sair (LIFO). Você pode usar qualquer classe de coleção que implemente a IProducerConsumerCollection<T> interface. O tipo de coleção padrão para BlockingCollection<T> é ConcurrentQueue<T>.