Interface IPipeline<TSource1, TSource2>

Namespace

DotnetKit.DataflowBuilder.Abstractions

Assembly

DotnetKit.DataflowBuilder.dll

Represents an executable multi-source dataflow pipeline that joins items from two distinct sources (TSource1 and TSource2) into paired tuples for downstream processing.

public interface IPipeline<TSource1, TSource2> : IPipeline<Tuple<TSource1, TSource2>>

Type Parameters

TSource1

The type of items accepted by the first source.

TSource2

The type of items accepted by the second source.

Inherited Members

IPipeline<Tuple<TSource1, TSource2>>.CompleteAsync()

IPipeline<Tuple<TSource1, TSource2>>.SendAsync(Tuple<TSource1, TSource2>, CancellationToken)

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)

Methods

Send1Async(TSource1, CancellationToken)

Asynchronously sends a data item into the first source input of the pipeline.

Task Send1Async(TSource1 dataItem, CancellationToken cancellationToken = default)

Parameters

dataItem TSource1

The data item to send to the first source.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task that completes when the item has been accepted by the first source buffer.

Send2Async(TSource2, CancellationToken)

Asynchronously sends a data item into the second source input of the pipeline.

Task Send2Async(TSource2 dataItem, CancellationToken cancellationToken = default)

Parameters

dataItem TSource2

The data item to send to the second source.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task

A task that completes when the item has been accepted by the second source buffer.