System.Reactive
6.0.1
Prefix Reserved
Requires NuGet 2.12 or higher.
dotnet add package System.Reactive --version 6.0.1
NuGet\Install-Package System.Reactive -Version 6.0.1
<PackageReference Include="System.Reactive" Version="6.0.1" />
paket add System.Reactive --version 6.0.1
#r "nuget: System.Reactive, 6.0.1"
// Install System.Reactive as a Cake Addin #addin nuget:?package=System.Reactive&version=6.0.1 // Install System.Reactive as a Cake Tool #tool nuget:?package=System.Reactive&version=6.0.1
Rx (Reactive Extensions for .NET)
Rx enables event-driven programming with a composable, declarative model.
Getting started
Run the following at a command line:
mkdir TryRx
cd TryRx
dotnet new console
dotnet add package System.Reactive
Alternatively, if you have Visual Studio installed, create a new .NET Console project, and then use the NuGet package manager to add a reference to System.Reactive
.
You can then add this code to your Program.cs
. This creates an observable source (ticks
) that produces an event once every second. It also adds a handler to that source that writes a message to the console for each event:
using System.Reactive.Linq;
IObservable<long> ticks = Observable.Timer(
dueTime: TimeSpan.Zero,
period: TimeSpan.FromSeconds(1));
ticks.Subscribe(
tick => Console.WriteLine($"Tick {tick}"));
Console.ReadLine();
Examples
Wrapping an existing event source as an Rx IObservable<T>
If you have an existing source of events that does not support Rx directly, but which does offer .NET events, you can bring this into the world of Rx using the Observable.FromEventPattern
method:
using System.Reactive.Linq;
FileSystemWatcher fsw = new FileSystemWatcher(@"C:\temp");
IObservable<FileSystemEventArgs> changeEvents = Observable
.FromEventPattern<FileSystemEventHandler, FileSystemEventArgs>(
h => fsw.Changed = h,
h => fsw.Changed -= h)
.Select(e => e.EventArgs);
fsw.EnableRaisingEvents = true;
Waiting for inactivity
It can sometimes be useful to wait for a period of inactivity before taking action. For example, if you have code that monitors a directory in a filesystem, processing modified or added files, it's common for there to be flurries of activity. For example, if a user is copying multiple files into a folder that you're observing, there will be multiple changes, and it could be more efficient to wait until those stop and then process all the changes in one batch, than to attempt to process everything immediately.
This example defines a custom Rx operator that can be attached to any source. It will wait for that source to start producing events, and then, it will wait for it to stop again for the specified period. Each time that happens, it reports all of the activity that occurred between the last two periods of inactivity:
static class RxExt
{
public static IObservable<IList<T>> Quiescent<T>(
this IObservable<T> src,
TimeSpan minimumInactivityPeriod,
IScheduler scheduler)
{
IObservable<int> onoffs =
from _ in src
from delta in Observable.Return(1, scheduler).Concat(Observable.Return(-1, scheduler).Delay(minimumInactivityPeriod, scheduler))
select delta;
IObservable<int> outstanding = onoffs.Scan(0, (total, delta) => total delta);
IObservable<int> zeroCrossings = outstanding.Where(total => total == 0);
return src.Buffer(zeroCrossings);
}
}
(This works by creating a sequence (onoffs
) that produces a value 1 each time activity occurs, and then a corresponding -1 after the specified time has elapsed. It then uses Scan
to produce the outstanding
sequence, which is just a running total of those onoffs
. This is effectively a count of the number of events that have happened recently (where 'recently' is defined as 'less than minimumInactivityPeriod
ago). Every new event that occurs raises this running total by 1, but each time the specified timespan has passed for a particular event, it drops by one. So when this drops back to 0, it means that there are no events that have occurred as recently as the minimumInactivityPeriod
. The zeroCrossings
sequence picks out just the events in which outstanding
drops back to zero. This has the effect that zeroCrossings
raises an event every time there has been some activity followed by minimumInactivityPeriod
of inactivity. Finally, we plug this into the Buffer
operator, which slices the input events (src
) into chunks. By passing it the zeroCrossings
source, we tell Buffer
to deliver a new slice every time the source becomes inactive. The effect is that the source returned by Quiescent
does nothing until there has been some activity followed by the specified period of inactivity, at which point it produces a single event reporting all of the source events that have occurred since the previous period, or in the initial case, all of the source events so far.)
You could use this in conjunction with the adapted FileSystemWatcher
from the preceding example:
IObservable<IList<FileSystemEventArgs>> fileActivityStopped = changeEvents
.Quiescent(TimeSpan.FromSeconds(2), Scheduler.Default);
await fileActivityStopped.ForEachAsync(
a => Console.WriteLine($"File changes stopped after {a.Count} changes"));
(Note: this only uses the Changed
event. A real application might also need to look at the FileSystemWatcher
's Created
, Renamed
, and Deleted
events.)
Feedback
You can create issues at the https://github.com/dotnet/reactive repository
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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. net6.0-windows10.0.19041 is compatible. 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 was computed. 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. |
.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 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. 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. |
Universal Windows Platform | uap10.0.18362 is compatible. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7.2
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETStandard 2.0
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
net6.0
- No dependencies.
-
net6.0-windows10.0.19041
- No dependencies.
-
UAP 10.0.18362
- System.Threading.Tasks.Extensions (>= 4.5.4)
NuGet packages (1.4K)
Showing the top 5 NuGet packages that depend on System.Reactive:
Package | Downloads |
---|---|
System.Reactive.Linq
Legacy facade for Reactive Extensions (Rx) for .NET |
|
System.Reactive.Core
Legacy facade for Reactive Extensions (Rx) for .NET |
|
System.Reactive.Interfaces
Legacy facade for Reactive Extensions (Rx) for .NET |
|
System.Reactive.PlatformServices
Legacy facade for Reactive Extensions (Rx) for .NET |
|
GraphQL.Client
A GraphQL Client for .NET Standard |
GitHub repositories (278)
Showing the top 5 popular GitHub repositories that depend on System.Reactive:
Repository | Stars |
---|---|
microsoft/PowerToys
Windows system utilities to maximize productivity
|
|
shadowsocks/shadowsocks-windows
A C# port of shadowsocks
|
|
AvaloniaUI/Avalonia
Develop Desktop, Embedded, Mobile and WebAssembly apps with C# and XAML. The most popular .NET UI client technology
|
|
BeyondDimension/SteamTools
🛠「Watt Toolkit」是一个开源跨平台的多功能 Steam 工具箱。
|
|
chocolatey/choco
Chocolatey - the package manager for Windows
|
Version | Downloads | Last updated |
---|---|---|
6.0.1 | 1,313,673 | 5/22/2024 |
6.0.1-preview.1 | 130,583 | 6/14/2023 |
6.0.0 | 13,387,892 | 5/19/2023 |
6.0.0-preview.16 | 713 | 5/17/2023 |
6.0.0-preview.13 | 7,668 | 4/20/2023 |
6.0.0-preview.9 | 28,737 | 3/31/2023 |
6.0.0-preview.1 | 7,502 | 3/10/2023 |
5.0.0 | 67,822,443 | 11/10/2020 |
5.0.0-preview.220 | 17,529 | 10/15/2020 |
5.0.0-preview.16 | 36,826 | 9/26/2020 |
4.4.1 | 41,892,286 | 4/2/2020 |
4.3.2 | 21,284,948 | 12/24/2019 |
4.3.1 | 925,535 | 12/4/2019 |
4.2.2 | 8,048 | 12/24/2019 |
4.2.0 | 1,815,070 | 10/10/2019 |
4.2.0-preview.625 | 35,598 | 8/19/2019 |
4.2.0-preview.566 | 12,400 | 6/14/2019 |
4.2.0-preview.102 | 26,355 | 2/24/2019 |
4.2.0-preview.63 | 138,563 | 12/12/2018 |
4.1.6 | 3,783,961 | 8/1/2019 |
4.1.5 | 4,664,460 | 4/10/2019 |
4.1.4 | 30,863 | 4/8/2019 |
4.1.3 | 1,707,394 | 2/18/2019 |
4.1.2 | 9,953,522 | 10/10/2018 |
4.1.1 | 218,305 | 10/1/2018 |
4.1.0 | 1,287,563 | 8/13/2018 |
4.1.0-preview.330 | 1,677 | 8/3/2018 |
4.1.0-preview.84 | 37,035 | 6/18/2018 |
4.0.0 | 22,912,405 | 5/25/2018 |
4.0.0-preview.4.build.391 | 32,726 | 5/23/2018 |
4.0.0-preview.3.build.380 | 11,945 | 5/16/2018 |
4.0.0-preview.2.build.379 | 11,635 | 5/12/2018 |
3.1.1 | 9,544,240 | 11/21/2016 |
3.1.0 | 156,606 | 11/5/2016 |
3.1.0-rc | 7,555 | 9/23/2016 |
3.0.0 | 2,150,491 | 6/27/2016 |