DataflowBlock Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a set of static (Shared in Visual Basic) methods for working with dataflow blocks.
public ref class DataflowBlock abstract sealedpublic static class DataflowBlocktype DataflowBlock = classPublic Module DataflowBlock- Inheritance
-
DataflowBlock
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.
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>. |
| Choose<T1,T2,T3>(ISourceBlock<T1>, Action<T1>, ISourceBlock<T2>, Action<T2>, ISourceBlock<T3>, Action<T3>) |
Monitors three dataflow sources, invoking the provided handler for whichever source makes data available first. |
| Choose<T1,T2,T3>(ISourceBlock<T1>, Action<T1>, ISourceBlock<T2>, Action<T2>, ISourceBlock<T3>, Action<T3>, DataflowBlockOptions) |
Monitors three dataflow sources, invoking the provided handler for whichever source makes data available first. |
| Choose<T1,T2>(ISourceBlock<T1>, Action<T1>, ISourceBlock<T2>, Action<T2>) |
Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first. |
| Choose<T1,T2>(ISourceBlock<T1>, Action<T1>, ISourceBlock<T2>, Action<T2>, DataflowBlockOptions) |
Monitors two dataflow sources, invoking the provided handler for whichever source makes data available first. |
| Encapsulate<TInput,TOutput>(ITargetBlock<TInput>, ISourceBlock<TOutput>) |
Encapsulates a target and a source into a single propagator. |
| LinkTo<TOutput>(ISourceBlock<TOutput>, ITargetBlock<TOutput>) |
Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. |
| 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>, Predicate<TOutput>) |
Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. |
| NullTarget<TInput>() |
Gets a target block that synchronously accepts all messages offered to it and drops them. |
| OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>) |
Provides a Task<TResult> that asynchronously monitors the source for available output. |
| OutputAvailableAsync<TOutput>(ISourceBlock<TOutput>, CancellationToken) |
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>) |
Synchronously receives a value from a specified source. |
| 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) |
Synchronously receives a value from a specified source, observing an optional time-out period. |
| 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. |
| ReceiveAllAsync<TOutput>(IReceivableSourceBlock<TOutput>, CancellationToken) |
Creates an IAsyncEnumerable<T> that enables receiving all of the data from the source. |
| ReceiveAsync<TOutput>(ISourceBlock<TOutput>) |
Asynchronously 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) |
Asynchronously receives a value from a specified source, observing an optional time-out period. |
| 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. |
| SendAsync<TInput>(ITargetBlock<TInput>, TInput) |
Asynchronously offers a message to the target message block, allowing for postponement. |
| SendAsync<TInput>(ITargetBlock<TInput>, TInput, CancellationToken) |
Asynchronously offers a message to the target message block, allowing for postponement. |
| TryReceive<TOutput>(IReceivableSourceBlock<TOutput>, TOutput) |
Attempts to synchronously receive an item from the ISourceBlock<TOutput>. |
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for