BlockingCollection<T>.TryTake 方法

參考

定義

命名空間:: System.Collections.Concurrent

組件:: System.Collections.Concurrent.dll

組件:: System.dll

組件:: netstandard.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

嘗試從 BlockingCollection<T> 移除項目。

多載

TryTake(T)	嘗試從 BlockingCollection<T> 移除項目。
TryTake(T, TimeSpan)	嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。
TryTake(T, Int32, CancellationToken)	當觀察取消語彙基元時，嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。
TryTake(T, Int32)	嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。

範例

下列範例會示範如何使用 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)

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

嘗試從 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

參數

item: T

要從集合中移除的項目。

傳回

Boolean

如果可以移除項目，則為 true，否則為 false。

例外狀況

ObjectDisposedException

BlockingCollection<T> 已經處置。

InvalidOperationException

基礎集合是在這個 BlockingCollection<T> 執行個體之外修改。

備註

如果集合是空的，這個方法會立即傳回 false。

項目的移除順序取決於用來建立 BlockingCollection<T> 執行個體的集合型別。建立 BlockingCollection<T> 物件時，您可以指定要使用的集合型別。例如，您可以針對先進先出 (FIFO) 行為指定 ConcurrentQueue<T> 物件，或針對後進先出 (LIFO) 行為指定 ConcurrentStack<T> 物件。您可以使用任何可實作 IProducerConsumerCollection<T> 介面的集合類別。 BlockingCollection<T> 的預設集合類型為 ConcurrentQueue<T>。

另請參閱

適用於

TryTake(T, TimeSpan)

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。

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

參數

item: T

要從集合中移除的項目。

timeout: TimeSpan

， TimeSpan 表示等候移除專案的毫秒數，或 TimeSpan 表示無限期等候的 -1 毫秒。

傳回

Boolean

true 如果項目可以在指定的時間內從集合中移除，則為 ;否則為 false。

例外狀況

ObjectDisposedException

BlockingCollection<T> 已經處置。

ArgumentOutOfRangeException

timeout 為 -1 毫秒以外的負數，表示無限逾時。

-或-

timeout 大於 Int32.MaxValue。

InvalidOperationException

基礎集合是在這個 BlockingCollection<T> 執行個體之外修改。

備註

另請參閱

適用於

TryTake(T, Int32, CancellationToken)

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

當觀察取消語彙基元時，嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。

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

參數

item: T

要從集合中移除的項目。

millisecondsTimeout: Int32

等候移除專案的毫秒數，或 Infinite (-1) 無限期等候。

cancellationToken: CancellationToken

要觀察的取消語彙基元。

傳回

Boolean

true 如果項目可以在指定的時間內從集合中移除，則為 ;否則為 false。

例外狀況

OperationCanceledException

CancellationToken 已取消。

ObjectDisposedException

BlockingCollection<T> 已處置或基礎 CancellationTokenSource 已經過處置。

ArgumentOutOfRangeException

millisecondsTimeout 為 -1 以外的負數，表示無限逾時。

InvalidOperationException

基礎集合曾在這個 BlockingCollection<T> 執行個體之外修改。

備註

另請參閱

適用於

TryTake(T, Int32)

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

來源:: BlockingCollection.cs

嘗試在指定的時間週期內，從 BlockingCollection<T> 中移除項目。

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

參數

item: T

要從集合中移除的項目。

millisecondsTimeout: Int32

等候移除專案的毫秒數，或 Infinite (-1) 無限期等候。

傳回

Boolean

true 如果項目可以在指定的時間內從集合中移除，則為 ;否則為 false。

例外狀況

ObjectDisposedException

BlockingCollection<T> 已經處置。

ArgumentOutOfRangeException

millisecondsTimeout 為 -1 以外的負數，表示無限逾時。

InvalidOperationException

基礎集合是在這個 BlockingCollection<T> 執行個體之外修改。

備註

項目的移除順序取決於用來建立 BlockingCollection<T> 執行個體的集合型別。當您建立 BlockingCollection<T>時，您可以指定要使用的集合類型。例如，您可以針對先進先出 (FIFO) 行為指定 ConcurrentQueue<T> 物件，或針對後進先出 (LIFO) 行為指定 ConcurrentStack<T> 物件。您可以使用任何可實作 IProducerConsumerCollection<T> 介面的集合類別。 BlockingCollection<T> 的預設集合類型為 ConcurrentQueue<T>。

另請參閱

適用於

共用方式為

BlockingCollection<T>.TryTake 方法

定義

多載

範例

TryTake(T)

參數

傳回

例外狀況

備註

另請參閱

適用於

TryTake(T, TimeSpan)

參數

傳回

例外狀況

備註

另請參閱

適用於

TryTake(T, Int32, CancellationToken)

參數

傳回

例外狀況

備註

另請參閱

適用於

TryTake(T, Int32)

參數

傳回

例外狀況

備註

另請參閱

適用於

其他資源