System.Threading.Tasks.Dataflow
9.0.0-rc.1.24431.7
Prefix Reserved
See the version list below for details.
dotnet add package System.Threading.Tasks.Dataflow --version 9.0.0-rc.1.24431.7
NuGet\Install-Package System.Threading.Tasks.Dataflow -Version 9.0.0-rc.1.24431.7
<PackageReference Include="System.Threading.Tasks.Dataflow" Version="9.0.0-rc.1.24431.7" />
paket add System.Threading.Tasks.Dataflow --version 9.0.0-rc.1.24431.7
#r "nuget: System.Threading.Tasks.Dataflow, 9.0.0-rc.1.24431.7"
// Install System.Threading.Tasks.Dataflow as a Cake Addin #addin nuget:?package=System.Threading.Tasks.Dataflow&version=9.0.0-rc.1.24431.7&prerelease // Install System.Threading.Tasks.Dataflow as a Cake Tool #tool nuget:?package=System.Threading.Tasks.Dataflow&version=9.0.0-rc.1.24431.7&prerelease
About
Provides dataflow components that are collectively referred to as the TPL Dataflow Library. This dataflow model promotes actor-based programming by providing in-process message passing for coarse-grained dataflow and pipelining tasks.
Key Features
- Foundation for message passing and parallelizing CPU-intensive and I/O-intensive applications that have high throughput and low latency.
- Provides multiple block types for various dataflow operations (e.g.,
BufferBlock
,ActionBlock
,TransformBlock
). - Dataflow blocks support linking to form networks, allowing you to create complex processing topologies.
How to Use
This sample demonstrates a dataflow pipeline that downloads the book "The Iliad of Homer" from a website and searches the text to match individual words with words that reverse the first word's characters.
using System.Net;
using System.Text.RegularExpressions;
using System.Threading.Tasks.Dataflow;
var nonLetterRegex = new Regex(@"\P{L}", RegexOptions.Compiled);
var client = new HttpClient(new HttpClientHandler { AutomaticDecompression = DecompressionMethods.GZip });
// Setup blocks
// Downloads the requested resource as a string.
TransformBlock<string, string> downloadString = new TransformBlock<string, string>(async uri =>
{
Console.WriteLine("Downloading '{0}'...", uri);
return await client.GetStringAsync(uri);
});
// Separates the specified text into an array of words.
TransformBlock<string, string[]> createWordList = new TransformBlock<string, string[]>(text =>
{
Console.WriteLine("Creating word list...");
// Remove common punctuation by replacing all non-letter characters with a space character.
text = nonLetterRegex.Replace(text, " ");
// Separate the text into an array of words.
return text.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries);
});
// Removes short words.
TransformBlock<string[], string[]> filterWordList = new TransformBlock<string[], string[]>(words =>
{
Console.WriteLine("Filtering word list...");
return words
.Where(word => word.Length > 3)
.ToArray();
});
// Finds all words in the specified collection whose reverse also exists in the collection.
TransformManyBlock<string[], string> findReversedWords = new TransformManyBlock<string[], string>(words =>
{
Console.WriteLine("Finding reversed words...");
var wordsSet = new HashSet<string>(words);
return from word in wordsSet
let reverse = string.Concat(word.Reverse())
where word != reverse && wordsSet.Contains(reverse)
select word;
});
// Prints the provided reversed words to the console.
ActionBlock<string> printReversedWords = new ActionBlock<string>(reversedWord =>
{
Console.WriteLine("Found reversed words {0}/{1}", reversedWord, string.Concat(reversedWord.Reverse()));
});
// Connect the dataflow blocks to form a pipeline.
var linkOptions = new DataflowLinkOptions { PropagateCompletion = true };
downloadString.LinkTo(createWordList, linkOptions);
createWordList.LinkTo(filterWordList, linkOptions);
filterWordList.LinkTo(findReversedWords, linkOptions);
findReversedWords.LinkTo(printReversedWords, linkOptions);
// Post data to the pipeline, "The Iliad of Homer" by Homer.
downloadString.Post("http://www.gutenberg.org/cache/epub/16452/pg16452.txt");
// Mark the head of the pipeline as complete.
downloadString.Complete();
// Wait for the last block in the pipeline to process all messages.
printReversedWords.Completion.Wait();
// Output:
// Downloading 'http://www.gutenberg.org/cache/epub/16452/pg16452.txt'...
// Creating word list...
// Filtering word list...
// Finding reversed words...
// Found reversed words parts/strap
// Found reversed words deer/reed
// Found reversed words deem/meed
// Found reversed words flow/wolf
// ...
More details can be found on Dataflow (Task Parallel Library) and Walkthrough: Creating a Dataflow Pipeline pages.
Main Types
The main types provided by this library are:
System.Threading.Tasks.Dataflow.ISourceBlock<TOutput>
System.Threading.Tasks.Dataflow.ITargetBlock<TInput>
System.Threading.Tasks.Dataflow.IPropagatorBlock<TInput,TOutput>
System.Threading.Tasks.Dataflow.ActionBlock<TInput>
System.Threading.Tasks.Dataflow.BatchBlock<T>
System.Threading.Tasks.Dataflow.BatchedJoinBlock<T1, T2>
System.Threading.Tasks.Dataflow.BroadcastBlock<T>
System.Threading.Tasks.Dataflow.BufferBlock<T>
System.Threading.Tasks.Dataflow.JoinBlock<T1, T2>
System.Threading.Tasks.Dataflow.TransformBlock<TInput, TOutput>
System.Threading.Tasks.Dataflow.TransformManyBlock<TInput, TOutput>
System.Threading.Tasks.Dataflow.WriteOnceBlock<T>
Additional Documentation
Feedback & Contributing
System.Threading.Tasks.Dataflow is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.2
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
-
.NETStandard 2.1
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages (522)
Showing the top 5 NuGet packages that depend on System.Threading.Tasks.Dataflow:
Package | Downloads |
---|---|
Microsoft.Azure.WebJobs
This package contains the runtime host components of the WebJobs SDK. For more information, please visit https://go.microsoft.com/fwlink/?linkid=2279708. |
|
Microsoft.Build
This package contains the Microsoft.Build assembly which is used to create, edit, and evaluate MSBuild projects. |
|
Microsoft.Build.Tasks.Core
This package contains the Microsoft.Build.Tasks assembly which implements the commonly used tasks of MSBuild. |
|
Microsoft.Build.Runtime
This package delivers a complete executable copy of MSBuild. Reference this package only if your application needs to load projects or execute in-process builds without requiring installation of MSBuild. Successfully evaluating projects using this package requires aggregating additional components (like the compilers) into an application directory. |
|
Microsoft.CodeAnalysis.Workspaces.MSBuild
.NET Compiler Platform ("Roslyn") support for analyzing MSBuild projects and solutions. This should be used with at least one of the following packages to add the appropriate language support: - Microsoft.CodeAnalysis.CSharp.Workspaces - Microsoft.CodeAnalysis.VisualBasic.Workspaces More details at https://aka.ms/roslyn-packages This package was built from the source at https://github.com/dotnet/roslyn/commit/bde21ee2b98b775b010d01a93f81ef587fe80962. |
GitHub repositories (122)
Showing the top 5 popular GitHub repositories that depend on System.Threading.Tasks.Dataflow:
Repository | Stars |
---|---|
jellyfin/jellyfin
The Free Software Media System
|
|
files-community/Files
A modern file manager that helps users organize their files and folders.
|
|
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
|
|
stride3d/stride
Stride (formerly Xenko), a free and open-source cross-platform C# game engine.
|
|
dotnet/msbuild
The Microsoft Build Engine (MSBuild) is the build platform for .NET and Visual Studio.
|