BlockingCollection<T>.TryTake Metodo

Definizione

Spazio dei nomi:

System.Collections.Concurrent

Assembly:

System.Collections.Concurrent.dll

Prova a rimuovere un elemento da BlockingCollection<T>.

Overload

TryTake(T)	Prova a rimuovere un elemento da BlockingCollection<T>.
TryTake(T, TimeSpan)	Prova rimuovere un elemento da BlockingCollection<T> entro il periodo di tempo specificato.
TryTake(T, Int32, CancellationToken)	Prova a rimuovere un elemento da BlockingCollection<T> nel periodo di tempo specificato, considerando un token di annullamento.
TryTake(T, Int32)	Prova rimuovere un elemento da BlockingCollection<T> entro il periodo di tempo specificato.

Esempio

Nell'esempio seguente viene illustrato come utilizzare il metodo 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)

Origine:

BlockingCollection.cs

Prova a rimuovere un elemento da 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

Parametri

item

T

Elemento da rimuovere dalla raccolta.

Restituisce

Boolean

true se è stato possibile rimuovere un elemento. In caso contrario, false.

Eccezioni

ObjectDisposedException

L'interfaccia BlockingCollection<T> è stata eliminata.

InvalidOperationException

La raccolta sottostante è stata modificata all'esterno di questa istanza di BlockingCollection<T>.

Commenti

Se la raccolta è vuota, questo metodo restituisce immediatamente false.

L'ordine in cui un elemento viene rimosso dipende dal tipo di raccolta utilizzato per creare l'istanza di BlockingCollection<T>. Quando si crea un oggetto BlockingCollection<T>, è possibile specificare il tipo di raccolta da utilizzare. Ad esempio, è possibile specificare un oggetto ConcurrentQueue<T> per il comportamento FIFO (First In, First Out) o un oggetto ConcurrentStack<T> per il comportamento LIFO (Last In, First Out). È possibile usare qualsiasi classe di raccolta che implementa l'interfaccia IProducerConsumerCollection<T>. Il tipo di raccolta predefinito per BlockingCollection<T> è ConcurrentQueue<T>.

Vedi anche

• Raccolte thread-safe
• Panoramica di BlockingCollection

TryTake(T, TimeSpan)

Origine:

BlockingCollection.cs

Prova rimuovere un elemento da BlockingCollection<T> entro il periodo di tempo specificato.

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

Parametri

item

T

Elemento da rimuovere dalla raccolta.

timeout

TimeSpan

Oggetto TimeSpan che rappresenta il numero di millisecondi di attesa per la rimozione dell'elemento o un oggetto TimeSpan che rappresenta -1 millisecondi di attesa illimitata.

Restituisce

Boolean

true se un elemento può essere rimosso dalla raccolta entro il tempo specificato; in caso contrario, false.

Eccezioni

ObjectDisposedException

L'interfaccia BlockingCollection<T> è stata eliminata.

ArgumentOutOfRangeException

timeout è un numero negativo diverso da -1 millisecondi, che rappresenta un timeout infinito.

-oppure-

timeout è maggiore di Int32.MaxValue.

InvalidOperationException

La raccolta sottostante è stata modificata all'esterno di questa istanza di BlockingCollection<T>.

Commenti

L'ordine in cui un elemento viene rimosso dipende dal tipo di raccolta utilizzato per creare l'istanza di BlockingCollection<T>. Quando si crea un oggetto BlockingCollection<T>, è possibile specificare il tipo di raccolta da utilizzare. Ad esempio, è possibile specificare un oggetto ConcurrentQueue<T> per il comportamento FIFO (First In, First Out) o un oggetto ConcurrentStack<T> per il comportamento LIFO (Last In, First Out). È possibile usare qualsiasi classe di raccolta che implementa l'interfaccia IProducerConsumerCollection<T>. Il tipo di raccolta predefinito per BlockingCollection<T> è ConcurrentQueue<T>.

Vedi anche

• Raccolte thread-safe
• Panoramica di BlockingCollection

TryTake(T, Int32, CancellationToken)

Origine:

BlockingCollection.cs

Prova a rimuovere un elemento da BlockingCollection<T> nel periodo di tempo specificato, considerando un token di annullamento.

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

Parametri

item

T

Elemento da rimuovere dalla raccolta.

millisecondsTimeout

Int32

Numero di millisecondi di attesa per la rimozione dell'elemento o Infinite (-1) di attesa illimitata.

cancellationToken

CancellationToken

Token di annullamento da osservare.

Restituisce

Boolean

true se un elemento può essere rimosso dalla raccolta entro il tempo specificato; in caso contrario, false.

Eccezioni

OperationCanceledException

CancellationToken è stato annullato.

ObjectDisposedException

BlockingCollection<T> è stato eliminato o l'oggetto CancellationTokenSource sottostante è stato eliminato.

ArgumentOutOfRangeException

millisecondsTimeout è un numero negativo diverso da -1, che rappresenta un timeout infinito.

InvalidOperationException

La raccolta sottostante è stata modificata all'esterno dell'istanza BlockingCollection<T>.

Commenti

L'ordine in cui un elemento viene rimosso dipende dal tipo di raccolta utilizzato per creare l'istanza di BlockingCollection<T>. Quando si crea un oggetto BlockingCollection<T>, è possibile specificare il tipo di raccolta da utilizzare. Ad esempio, è possibile specificare un oggetto ConcurrentQueue<T> per il comportamento FIFO (First In, First Out) o un oggetto ConcurrentStack<T> per il comportamento LIFO (Last In, First Out). È possibile usare qualsiasi classe di raccolta che implementa l'interfaccia IProducerConsumerCollection<T>. Il tipo di raccolta predefinito per BlockingCollection<T> è ConcurrentQueue<T>.

Vedi anche

• Raccolte thread-safe
• Panoramica di BlockingCollection

TryTake(T, Int32)

Origine:

BlockingCollection.cs

Prova rimuovere un elemento da BlockingCollection<T> entro il periodo di tempo specificato.

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

Parametri

item

T

Elemento da rimuovere dalla raccolta.

millisecondsTimeout

Int32

Numero di millisecondi di attesa per la rimozione dell'elemento o Infinite (-1) di attesa illimitata.

Restituisce

Boolean

true se un elemento può essere rimosso dalla raccolta entro il tempo specificato; in caso contrario, false.

Eccezioni

ObjectDisposedException

L'interfaccia BlockingCollection<T> è stata eliminata.

ArgumentOutOfRangeException

millisecondsTimeout è un numero negativo diverso da -1, che rappresenta un timeout infinito.

InvalidOperationException

La raccolta sottostante è stata modificata all'esterno di questa istanza di BlockingCollection<T>.

Commenti

L'ordine in cui un elemento viene rimosso dipende dal tipo di raccolta utilizzato per creare l'istanza di BlockingCollection<T>. Quando si crea un BlockingCollection<T>oggetto , è possibile specificare il tipo di raccolta da usare. Ad esempio, è possibile specificare un oggetto ConcurrentQueue<T> per il comportamento FIFO (First In, First Out) o un oggetto ConcurrentStack<T> per il comportamento LIFO (Last In, First Out). È possibile usare qualsiasi classe di raccolta che implementa l'interfaccia IProducerConsumerCollection<T>. Il tipo di raccolta predefinito per BlockingCollection<T> è ConcurrentQueue<T>.

Vedi anche

• Raccolte thread-safe
• Panoramica di BlockingCollection