BlockingCollection<T>.TryTake Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Пытается удалить элемент из элемента 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.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
Элемент, который нужно удалить из коллекции.
Возвращаемое значение
Исключения
Он BlockingCollection<T> был удален.
Базовая коллекция была изменена за пределами этого BlockingCollection<T> экземпляра.
Комментарии
Если коллекция пуста, этот метод немедленно возвращает значение false.
Порядок удаления элемента зависит от типа коллекции, используемой для создания экземпляра BlockingCollection<T> . При создании BlockingCollection<T> объекта можно указать тип используемой коллекции. Например, можно указать ConcurrentQueue<T> объект для первого, первого выхода (FIFO) или ConcurrentStack<T> объекта для последнего в поведении (LIFO). Вы можете использовать любой класс коллекции, реализующий IProducerConsumerCollection<T> интерфейс. Тип коллекции по умолчанию для BlockingCollection<T> это ConcurrentQueue<T>.
См. также раздел
Применяется к
TryTake(T, TimeSpan)
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- 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 миллисекундах, которые будут ждать неограниченное время.
Возвращаемое значение
true Значение , если элемент может быть удален из коллекции в течение указанного времени; falseв противном случае .
Исключения
Он BlockingCollection<T> был удален.
timeout — отрицательное число, отличное от -1 миллисекундах, которое представляет бесконечное время ожидания.
–или–
timeout больше int32.MaxValue.
Базовая коллекция была изменена за пределами этого BlockingCollection<T> экземпляра.
Комментарии
Порядок удаления элемента зависит от типа коллекции, используемой для создания экземпляра BlockingCollection<T> . При создании BlockingCollection<T> объекта можно указать тип используемой коллекции. Например, можно указать ConcurrentQueue<T> объект для первого, первого выхода (FIFO) или ConcurrentStack<T> объекта для последнего в поведении (LIFO). Вы можете использовать любой класс коллекции, реализующий IProducerConsumerCollection<T> интерфейс. Тип коллекции по умолчанию для BlockingCollection<T> это ConcurrentQueue<T>.
См. также раздел
Применяется к
TryTake(T, Int32, CancellationToken)
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- 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
Маркер отмены для наблюдения.
Возвращаемое значение
true Значение , если элемент может быть удален из коллекции в течение указанного времени; falseв противном случае .
Исключения
Отменено CancellationToken .
Он BlockingCollection<T> был удален или базовый CancellationTokenSource был удален.
millisecondsTimeout — отрицательное число, отличное от -1, которое представляет бесконечное время ожидания.
Базовая коллекция была изменена за пределами этого BlockingCollection<T> экземпляра.
Комментарии
Порядок удаления элемента зависит от типа коллекции, используемой для создания экземпляра BlockingCollection<T> . При создании BlockingCollection<T> объекта можно указать тип используемой коллекции. Например, можно указать ConcurrentQueue<T> объект для первого, первого выхода (FIFO) или ConcurrentStack<T> объекта для последнего в поведении (LIFO). Вы можете использовать любой класс коллекции, реализующий IProducerConsumerCollection<T> интерфейс. Тип коллекции по умолчанию для BlockingCollection<T> это ConcurrentQueue<T>.
См. также раздел
Применяется к
TryTake(T, Int32)
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- BlockingCollection.cs
- Исходный код:
- 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) для ожидания неограниченное время.
Возвращаемое значение
true Значение , если элемент может быть удален из коллекции в течение указанного времени; falseв противном случае .
Исключения
Он BlockingCollection<T> был удален.
millisecondsTimeout — отрицательное число, отличное от -1, которое представляет бесконечное время ожидания.
Базовая коллекция была изменена за пределами этого BlockingCollection<T> экземпляра.
Комментарии
Порядок удаления элемента зависит от типа коллекции, используемой для создания экземпляра BlockingCollection<T> . При создании BlockingCollection<T>коллекции можно указать тип используемой коллекции. Например, можно указать ConcurrentQueue<T> объект для первого, первого выхода (FIFO) или ConcurrentStack<T> объекта для последнего в поведении (LIFO). Вы можете использовать любой класс коллекции, реализующий IProducerConsumerCollection<T> интерфейс. Тип коллекции по умолчанию для BlockingCollection<T> это ConcurrentQueue<T>.