Interface IPipeline<TSource>
- Namespace
- DotnetKit.DataflowBuilder.Abstractions
- Assembly
- DotnetKit.DataflowBuilder.dll
Represents an executable dataflow pipeline that accepts input items of type TSource,
processes them through interconnected dataflow blocks, and monitors completion across all stages.
public interface IPipeline<TSource>
Type Parameters
TSourceThe type of items accepted by the pipeline source.
- Extension Methods
Methods
CompleteAsync()
Signals the pipeline's input block that no further data will be sent, and waits asynchronously for all blocks in the pipeline to finish processing.
Task CompleteAsync()
Returns
- Task
A task that completes when all pipeline stages have successfully completed or faulted.
SendAsync(TSource, CancellationToken)
Asynchronously sends a data item into the entry block of the pipeline.
Task SendAsync(TSource dataItem, CancellationToken cancellationToken = default)
Parameters
dataItemTSourceThe data item to post into the pipeline.
cancellationTokenCancellationTokenA token to monitor for cancellation requests.
Returns
- Task
A task that completes when the item has been accepted by the input buffer.