BatchBlock<T> Класс

Определение

Пространство имен:

System.Threading.Tasks.Dataflow

Сборка:

System.Threading.Tasks.Dataflow.dll

Пакет:

System.Threading.Tasks.Dataflow v11.0.0-preview.4.26230.115

Исходный код:

BatchBlock.cs

Предоставляет блок потока данных, который пакетирует входные данные в массивы.

generic <typename T>
public ref class BatchBlock sealed : System::Threading::Tasks::Dataflow::IPropagatorBlock<T, cli::array <T> ^>, System::Threading::Tasks::Dataflow::IReceivableSourceBlock<cli::array <T> ^>, System::Threading::Tasks::Dataflow::ISourceBlock<cli::array <T> ^>, System::Threading::Tasks::Dataflow::ITargetBlock<T>

public sealed class BatchBlock<T> : System.Threading.Tasks.Dataflow.IPropagatorBlock<T,T[]>, System.Threading.Tasks.Dataflow.IReceivableSourceBlock<T[]>, System.Threading.Tasks.Dataflow.ISourceBlock<T[]>, System.Threading.Tasks.Dataflow.ITargetBlock<T>

type BatchBlock<'T> = class
    interface IPropagatorBlock<'T, 'T[]>
    interface ITargetBlock<'T>
    interface IDataflowBlock
    interface ISourceBlock<'T[]>
    interface IReceivableSourceBlock<'T[]>

Public NotInheritable Class BatchBlock(Of T)
Implements IPropagatorBlock(Of T, T()), IReceivableSourceBlock(Of T()), ISourceBlock(Of T()), ITargetBlock(Of T)

Параметры типа

T

Указывает тип данных, помещаемых в пакеты.

Наследование

Object

BatchBlock<T>

Реализации

IDataflowBlock IPropagatorBlock<T,T[]> IReceivableSourceBlock<T[]> ISourceBlock<T[]> ISourceBlock<TOutput> ITargetBlock<T> ITargetBlock<TInput>

Комментарии

Note

Библиотека потоков данных TPL (пространство имен System.Threading.Tasks.Dataflow) не распространяется с помощью .NET. Чтобы установить пространство имен System.Threading.Tasks.Dataflow в Visual Studio, откройте проект, выберите Управление пакетами NuGet в меню Project и найдите пакет System.Threading.Tasks.Dataflow в Интернете. Кроме того, чтобы установить его с помощью cli .NET Core, запустите dotnet add package System.Threading.Tasks.Dataflow.

Конструкторы

Имя	Описание
BatchBlock<T>(Int32, GroupingDataflowBlockOptions)	Инициализирует новый BatchBlock<T> с указанным размером пакета, вариантом уменьшения и параметрами блокировки.
BatchBlock<T>(Int32)	Инициализирует новый BatchBlock<T> с указанным размером пакета.

Свойства

Имя	Описание
BatchSize	Возвращает размер пакетов, созданных этим BatchBlock<T>.
Completion	Возвращает объект Task , представляющий асинхронную операцию и завершение блока потока данных.
OutputCount	Возвращает количество выходных элементов, доступных для получения из этого блока.

Методы

Имя	Описание
Complete()	Сигналит о IDataflowBlock том, что он не должен принимать и не создавать больше сообщений, а также не потреблять больше отложенных сообщений.
LinkTo(ITargetBlock<T[]>, DataflowLinkOptions)	Связывает указанный ISourceBlock<TOutput>ITargetBlock<TInput> объект.
ToString()	Возвращает строку, представляющую отформатированное имя этого IDataflowBlock экземпляра.
TriggerBatch()	Активирует BatchBlock<T> запуск операции пакетной обработки, даже если число текущих очередей или отложенных элементов меньше BatchSize.
TryReceive(Predicate<T[]>, T[])	Пытается синхронно получать доступный выходной элемент из .IReceivableSourceBlock<TOutput>
TryReceiveAll(IList<T[]>)	Пытается синхронно получать все доступные элементы из .IReceivableSourceBlock<TOutput>

Явные реализации интерфейса

Имя	Описание
IDataflowBlock.Fault(Exception)	Вызывает IDataflowBlock завершение в Faulted состоянии.
ISourceBlock<T[]>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<T[]>, Boolean)	Вызывается связанным ITargetBlock<TInput> , чтобы принять и использовать ранее предложенный DataflowMessageHeader этим ISourceBlock<TOutput> методом.
ISourceBlock<T[]>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<T[]>)	Вызывается связанной ITargetBlock<TInput> для выпуска ранее зарезервированного DataflowMessageHeader этим ISourceBlock<TOutput>параметром.
ISourceBlock<T[]>.ReserveMessage(DataflowMessageHeader, ITargetBlock<T[]>)	Вызывается связанным ITargetBlock<TInput> резервом ранее предлагаемым DataflowMessageHeader этим ISourceBlock<TOutput>.
ITargetBlock<T>.OfferMessage(DataflowMessageHeader, T, ISourceBlock<T>, Boolean)	Предлагает сообщение, ITargetBlock<TInput>предоставляя целевому объекту возможность использовать или отложить сообщение.

Методы расширения

Имя	Описание
AsObservable<TOutput>(ISourceBlock<TOutput>)	Создает новую IObservable<T> абстракцию поверх ISourceBlock<TOutput>.
AsObserver<TInput>(ITargetBlock<TInput>)	Создает новую IObserver<T> абстракцию поверх ITargetBlock<TInput>.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>)	ISourceBlock<TOutput> Связывает указанный ITargetBlock<TInput> с помощью указанного фильтра.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>)	ISourceBlock<TOutput> Связывает указанный ITargetBlock<TInput> с помощью указанного фильтра.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>)	Связывает указанный ISourceBlock<TOutput>ITargetBlock<TInput>объект.
OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Предоставляет асинхронный Task<TResult> мониторинг источника для доступных выходных данных.
OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>)	Предоставляет асинхронный Task<TResult> мониторинг источника для доступных выходных данных.
Post<TInput>(ITargetBlock<TInput>, TInput)	Отправляет элемент в элемент ITargetBlock<TInput>.
Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Синхронно получает значение из указанного источника и предоставляет маркер для отмены операции.
Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Синхронно получает значение из указанного источника, предоставляя маркер для отмены операции и наблюдая за необязательным интервалом времени ожидания.
Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Синхронно получает значение из указанного источника, наблюдая за необязательным периодом ожидания.
Receive<TOutput>(ISourceBlock<TOutput>)	Синхронно получает значение из указанного источника.
ReceiveAllAsync<TOutput>(IReceivableSourceBlock<TOutput>, CancellationToken)	Создает объект IAsyncEnumerable<T> , позволяющий получать все данные из источника.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Асинхронно получает значение из указанного источника и предоставляет маркер для отмены операции.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Асинхронно получает значение из указанного источника, предоставляя маркер для отмены операции и наблюдая необязательный интервал времени ожидания.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Асинхронно получает значение из указанного источника, наблюдая за необязательным периодом ожидания.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Асинхронно получает значение из указанного источника.
SendAsync<TInput>(ITargetBlock<TInput>, TInput, CancellationToken)	Асинхронно предлагает сообщение целевому блоку сообщений, что позволяет отложить.
SendAsync<TInput>(ITargetBlock<TInput>, TInput)	Асинхронно предлагает сообщение целевому блоку сообщений, что позволяет отложить.
TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput)	Пытается синхронно получить элемент из элемента ISourceBlock<TOutput>.