IPropagatorBlock<TInput,TOutput> Interface

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Represents a dataflow block that is both a target for data and a source of data.

generic <typename TInput, typename TOutput>
public interface class IPropagatorBlock : System::Threading::Tasks::Dataflow::ISourceBlock<TOutput>, System::Threading::Tasks::Dataflow::ITargetBlock<TInput>

public interface IPropagatorBlock<in TInput,out TOutput> : System.Threading.Tasks.Dataflow.ISourceBlock<out TOutput>, System.Threading.Tasks.Dataflow.ITargetBlock<in TInput>

type IPropagatorBlock<'Input, 'Output> = interface
    interface IDataflowBlock
    interface ISourceBlock<'Output>
    interface ITargetBlock<'Input>

Public Interface IPropagatorBlock(Of In TInput, Out TOutput)
Implements ISourceBlock(Of Out TOutput), ITargetBlock(Of In TInput)

Type Parameters

TInput

Specifies the type of data accepted by the IPropagatorBlock<TInput,TOutput>.

This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

TOutput

Specifies the type of data supplied by the IPropagatorBlock<TInput,TOutput>.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

Derived

System.Threading.Tasks.Dataflow.BatchBlock<T>

System.Threading.Tasks.Dataflow.BroadcastBlock<T>

System.Threading.Tasks.Dataflow.BufferBlock<T>

System.Threading.Tasks.Dataflow.TransformBlock<TInput,TOutput>

System.Threading.Tasks.Dataflow.TransformManyBlock<TInput,TOutput>

System.Threading.Tasks.Dataflow.WriteOnceBlock<T>

Implements

IDataflowBlock ISourceBlock<TOutput> ITargetBlock<TInput>

Remarks

Note

The TPL Dataflow Library (the System.Threading.Tasks.Dataflow namespace) is not distributed with .NET. To install the System.Threading.Tasks.Dataflow namespace in Visual Studio, open your project, choose Manage NuGet Packages from the Project menu, and search online for the System.Threading.Tasks.Dataflow package. Alternatively, to install it using the .NET Core CLI, run dotnet add package System.Threading.Tasks.Dataflow.

Properties

Completion

Gets a Task that represents the asynchronous operation and completion of the dataflow block. (Inherited from IDataflowBlock)

Methods

Complete()	Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages. (Inherited from IDataflowBlock)
ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean)	Called by a linked ITargetBlock<TInput> to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock<TOutput>. (Inherited from ISourceBlock<TOutput>)
Fault(Exception)	Causes the IDataflowBlock to complete in a Faulted state. (Inherited from IDataflowBlock)
LinkTo(ITargetBlock<TOutput>, DataflowLinkOptions)	Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. (Inherited from ISourceBlock<TOutput>)
OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean)	Offers a message to the ITargetBlock<TInput>, giving the target the opportunity to consume or postpone the message. (Inherited from ITargetBlock<TInput>)
ReleaseReservation(DataflowMessageHeader, ITargetBlock<TOutput>)	Called by a linked ITargetBlock<TInput> to release a previously reserved DataflowMessageHeader by this ISourceBlock<TOutput>. (Inherited from ISourceBlock<TOutput>)
ReserveMessage(DataflowMessageHeader, ITargetBlock<TOutput>)	Called by a linked ITargetBlock<TInput> to reserve a previously offered DataflowMessageHeader by this ISourceBlock<TOutput>. (Inherited from ISourceBlock<TOutput>)

Extension Methods

AsObservable<TOutput>(ISourceBlock<TOutput>)	Creates a new IObservable<T> abstraction over the ISourceBlock<TOutput>.
AsObserver<TInput>(ITargetBlock<TInput>)	Creates a new IObserver<T> abstraction over the ITargetBlock<TInput>.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, Predicate<TOutput>)	Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>, DataflowLinkOptions, Predicate<TOutput>)	Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter.
LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>)	Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>.
OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Provides a Task<TResult> that asynchronously monitors the source for available output.
OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>)	Provides a Task<TResult> that asynchronously monitors the source for available output.
Post<TInput>(ITargetBlock<TInput>, TInput)	Posts an item to the ITargetBlock<TInput>.
Receive<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Synchronously receives a value from a specified source and provides a token to cancel the operation.
Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
Receive<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Synchronously receives a value from a specified source, observing an optional time-out period.
Receive<TOutput>(ISourceBlock<TOutput>)	Synchronously receives a value from a specified source.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken)	Asynchronously receives a value from a specified source and provides a token to cancel the operation.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan, CancellationToken)	Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>, TimeSpan)	Asynchronously receives a value from a specified source, observing an optional time-out period.
ReceiveAsync<TOutput>(ISourceBlock<TOutput>)	Asynchronously receives a value from a specified source.
SendAsync<TInput>(ITargetBlock<TInput>, TInput, CancellationToken)	Asynchronously offers a message to the target message block, allowing for postponement.
SendAsync<TInput>(ITargetBlock<TInput>, TInput)	Asynchronously offers a message to the target message block, allowing for postponement.