Class DataflowPipeline<TSource>

Implements an executable single-source dataflow pipeline encapsulating an ingress target block and an egress destination block.

public class DataflowPipeline<TSource> : IPipeline<TSource>

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: PipelineExtensions.SendAllAsync<TSource>(IPipeline<TSource>, IAsyncEnumerable<TSource>, bool, CancellationToken)

PipelineExtensions.SendAllAsync<TSource>(IPipeline<TSource>, IEnumerable<TSource>, bool, CancellationToken)

PipelineExtensions.SendFromChannelAsync<TSource>(IPipeline<TSource>, ChannelReader<TSource>, bool, CancellationToken)

Constructors

Initializes a new instance of the DataflowPipeline<TSource> class.

public DataflowPipeline(ITargetBlock<TSource> sourceBlock, IDataflowBlock destinationBlock)

sourceBlock ITargetBlock<TSource>: The entry target block that receives incoming data items.
destinationBlock IDataflowBlock: The final block in the pipeline chain whose completion signals overall pipeline termination.

ArgumentNullException: Thrown if sourceBlock or destinationBlock is null.

Signals completion to the entry block and waits asynchronously until all pipeline stages have completed.

public Task CompleteAsync()

Task: A task that represents completion of both the source and destination blocks.

Asynchronously sends a data item into the entry block of the pipeline.

public Task SendAsync(TSource dataItem, CancellationToken cancellationToken = default)

dataItem TSource: The item to send.
cancellationToken CancellationToken: A token to monitor for cancellation requests.