Class TimeBatchBlock<T>

Namespace

DotnetKit.DataflowBuilder.CustomBlocks

Assembly

DotnetKit.DataflowBuilder.dll

A custom propagator block that groups incoming items into batches of up to batchSize items, or flushes earlier if a specified timeout duration has elapsed since the first buffered item.

public class TimeBatchBlock<T> : BasePropagatorBlock<T, T[]>, IPropagatorBlock<T, T[]>, ITargetBlock<T>, ISourceBlock<T[]>, IDataflowBlock

Type Parameters

T

The type of incoming data items.

Inheritance

object

BasePropagatorBlock<T, T[]>

TimeBatchBlock<T>

Implements

IPropagatorBlock<T, T[]>

ITargetBlock<T>

ISourceBlock<T[]>

IDataflowBlock

Inherited Members

BasePropagatorBlock<T, T[]>.Target

BasePropagatorBlock<T, T[]>.Source

BasePropagatorBlock<T, T[]>.Pipeline

BasePropagatorBlock<T, T[]>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<T[]>, out bool)

BasePropagatorBlock<T, T[]>.LinkTo(ITargetBlock<T[]>, DataflowLinkOptions)

BasePropagatorBlock<T, T[]>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<T[]>)

BasePropagatorBlock<T, T[]>.ReserveMessage(DataflowMessageHeader, ITargetBlock<T[]>)

BasePropagatorBlock<T, T[]>.OfferMessage(DataflowMessageHeader, T, ISourceBlock<T>, bool)

BasePropagatorBlock<T, T[]>.Complete()

BasePropagatorBlock<T, T[]>.Fault(Exception)

BasePropagatorBlock<T, T[]>.Completion

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TimeBatchBlock(int, TimeSpan, CancellationToken)

Initializes a new instance of the TimeBatchBlock<T> class.

public TimeBatchBlock(int batchSize, TimeSpan timeout, CancellationToken cancellationToken = default)

Parameters

batchSize int

The maximum number of items per batch.

timeout TimeSpan

The maximum time to wait before emitting a partial batch.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Exceptions

ArgumentOutOfRangeException

Thrown if batchSize is less than 1 or timeout is negative.

Properties

Source

Gets the egress source block.

public override ISourceBlock<T[]> Source { get; }

Property Value

ISourceBlock<T[]>

Target

Gets the entry target block.

public override ITargetBlock<T> Target { get; }

Property Value

ITargetBlock<T>

Methods

Complete()

Signals the target block that no more data will be provided, and propagates completion to the source block.

public override void Complete()

Fault(Exception)

Causes the encapsulated dataflow block to complete in a faulted state with the specified exception.

public override void Fault(Exception exception)

Parameters

exception Exception

The exception that caused the fault.