ThrottleDebounce 2.0.0
dotnet add package ThrottleDebounce --version 2.0.0
NuGet\Install-Package ThrottleDebounce -Version 2.0.0
<PackageReference Include="ThrottleDebounce" Version="2.0.0" />
paket add ThrottleDebounce --version 2.0.0
#r "nuget: ThrottleDebounce, 2.0.0"
// Install ThrottleDebounce as a Cake Addin #addin nuget:?package=ThrottleDebounce&version=2.0.0 // Install ThrottleDebounce as a Cake Tool #tool nuget:?package=ThrottleDebounce&version=2.0.0
Rate-limit your actions and funcs by throttling and debouncing them. Retry when an exception is thrown.
This is a .NET library that lets you rate-limit delegates so they are only executed at most once in a given interval, even if they are invoked multiple times in that interval. You can also invoke a delegate and automatically retry it if it fails.
Installation
This package is available on NuGet Gallery.
dotnet add package ThrottleDebounce
Install-Package ThrottleDebounce
It targets .NET Standard 2.0 and .NET Framework 4.5.2, so it should be compatible with many runtimes.
Rate limiting
Usage
Action originalAction;
Func<int> originalFunc;
TimeSpan wait = TimeSpan.FromMilliseconds(50);
using RateLimitedAction throttledAction = Throttler.Throttle(originalAction, wait, leading: true, trailing: true);
using RateLimitedFunc<int> debouncedFunc = Debouncer.Debounce(originalFunc, wait, leading: false, trailing: true);
throttledAction.Invoke();
int? result = debouncedFunc.Invoke();
- Call
Throttler.Throttle()
to throttle your delegate, orDebouncer.Debounce()
to debounce it. PassAction action
/Func func
— your delegate to rate-limitTimeSpan wait
— how long to wait between executionsbool leading
—true
if the first invocation should be executed immediately, orfalse
if it should be queued. Optional, defaults totrue
for throttling andfalse
for debouncing.bool trailing
—true
if subsequent invocations in the waiting period should be enqueued for later execution once the waiting interval is over, orfalse
if they should be discarded. Optional, defaults totrue
.
- Call the resulting
RateLimitedAction
/RateLimitedFunc
object'sInvoke()
method to enqueue an invocation.RateLimitedFunc.Invoke
will returndefault
(e.g.null
) ifleading
isfalse
and the rate-limitedFunc
has not been executed before. Otherwise, it will return theFunc
's most recent return value.
- Your delegate will be executed at the desired rate.
- Optionally call the
RateLimitedAction
/RateLimitedFunc
object'sDispose()
method to prevent all queued executions from running when you are done.
Understanding throttling and debouncing
Summary
Throttling and debouncing both restrict a function to not execute too often, no matter how frequently you invoke it.
This is useful if the function is invoked very frequently, like whenever the mouse moves, but you don't want to it to run every single time the pointer moves 1 pixel, because the function is expensive, such as rendering a user interface.
Throttling allows the function to still be executed periodically, even with a constant stream of invocations.
Debouncing prevents the function from being executed at all until it hasn't been invoked for a while.
An invocation can result in at most one execution. For example, if both leading
and trailing
are true
, one single invocation will execute once on the leading edge and not on the trailing edge.
Diagram
Lodash documentation
Article and demo
Debouncing and Throttling Explained Through Examples by David Corbacho
Examples
Throttle an action to execute at most every 1 second
Action throttled = Throttler.Throttle(() => Console.WriteLine("hi"), TimeSpan.FromSeconds(1)).Invoke;
throttled(); //logs at 0s
throttled(); //logs at 1s
Thread.Sleep(1000);
throttled(); //logs at 2s
Debounce a function to execute after no invocations for 200 milliseconds
Func<double, double, double> debounced = Debouncer.Debounce((double x, double y) => Math.Sqrt(x * x + y * y),
TimeSpan.FromMilliseconds(200)).Invoke;
double? result;
result = debounced(1, 1); //never runs
result = debounced(2, 2); //never runs
result = debounced(3, 4); //runs at 200ms
Canceling a rate-limited action so any queued executions won't run
RateLimitedAction rateLimited = Throttler.Throttle(() => Console.WriteLine("hello"), TimeSpan.FromSeconds(1));
rateLimited.Invoke(); //runs at 0s
rateLimited.Dispose();
rateLimited.Invoke(); //never runs
Save a WPF window's position to the registry at most every 1 second
static void SaveWindowLocation(double x, double y) => Registry.SetValue(@"HKEY_CURRENT_USER\Software\My Program",
"Window Location", $"{x},{y}");
Action<double, double> saveWindowLocationThrottled = Throttler.Throttle<double, double>(saveWindowLocation,
TimeSpan.FromSeconds(1)).Invoke;
LocationChanged += (sender, args) => SaveWindowLocationThrottled(Left, Top);
Prevent accidental double-clicks on a WPF button
public MainWindow(){
InitializeComponent();
Action<object, RoutedEventArgs> onButtonClickDebounced = Debouncer.Debounce<object, RoutedEventArgs>(
OnButtonClick, TimeSpan.FromMilliseconds(40), true, false).Invoke;
MyButton.Click += new RoutedEventHandler(onButtonClickDebounced);
}
private void OnButtonClick(object sender, RoutedEventArgs e) {
MessageBox.Show("Button clicked");
}
Retrying
Given a function or action, you can execute it and, if it threw an exception, automatically execute it again until it succeeds.
Usage
Retrier.Attempt(attempt => MyErrorProneAction(), maxAttempts: 2);
- Call
Retrier.Attempt()
. PassAction<int> action
/Func<int, T> func
— your delegate to attempt, and possibly retry if it throws exceptions. The attempt number will be passed as theint
parameter, starting with0
before the first attempt. If this func returns aTask
, it will be awaited to determine if it threw an exception.int maxAttempts
— the maximum number of times the delegate may be executed, including the initial attempt. Optional, defaults to2
. Must be at least1
.Func<int, TimeSpan> delay
— how long to wait between attempts, as a function of the attempt number. The upcoming attempt number will be passed as a parameter, starting with1
before the second attempt. You can return a constantTimeSpan
for a fixed delay, or pass longer values for subsequent attempts to implement, for example, exponential backoff. Optional, defaults to no delay.Func<Exception, bool> isRetryAllowed
— whether the delegate is permitted to execute again after a givenException
instance. Returntrue
to allow orfalse
to deny retries. For example, you may want to retry after HTTP 500 errors since subsequent requests may succeed, but stop after the first failure for an HTTP 403 error which probably won't succeed if the same request is sent again. Optional, defaults to retrying on all exceptions besidesOutOfMemoryException
.Action beforeRetry
/Func<Task> beforeRetry
— a delegate to run extra logic between attempts, for example, if you want to log a message or perform any cleanup before the next attempt. Optional, defaults to not running anything between attempts.CancellationToken cancellationToken
— used to cancel the attempts and delays before they have all completed. Optional, defaults to no cancellation token. When cancelled,Attempt()
throws aTaskCancelledException
.
- If your delegate returns a value, it will be returned by
Attempt()
.
Example
Send at most 5 HTTP requests, 2 seconds apart, until a 200 response is received
using HttpClient httpClient = new();
HttpStatusCode statusCode = await Retrier.Attempt(async attempt => {
Console.WriteLine($"Attempt #{attempt:N0}...");
HttpResponseMessage response = await httpClient.GetAsync("https://httpbin.org/status/200%2C500");
Console.WriteLine($"Received response status code {(int) response.StatusCode}.");
response.EnsureSuccessStatusCode(); // throws HttpRequestException for status codes outside the range [200, 300)
return response.StatusCode;
}, 5, _ => TimeSpan.FromSeconds(2));
Console.WriteLine($"Final response: {(int) statusCode}")
Attempt #0...
Received response status code 500
Attempt #1...
Received response status code 500
Attempt #2...
Received response status code 200
Final response: 200
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 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 | net452 is compatible. net46 was computed. net461 was computed. net462 was computed. 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.5.2
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
NuGet packages (51)
Showing the top 5 NuGet packages that depend on ThrottleDebounce:
Package | Downloads |
---|---|
Elsa
Bundles the most commonly-used packages when building an Elsa workflows application. |
|
Elsa.Workflows.Runtime
Provides workflow runtime functionality. |
|
Elsa.Retention
Provides retention options for workflows. |
|
Elsa.EntityFrameworkCore
Provides Entity Framework Core implementations of various abstractions from various modules. |
|
Elsa.Http
Provides HTTP activities to listen for and send out HTTP requests. |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on ThrottleDebounce:
Repository | Stars |
---|---|
elsa-workflows/elsa-core
A .NET workflows library
|
|
elsa-workflows/elsa-studio
A modular, extensible dashboard application framework
|
Version | Downloads | Last updated |
---|---|---|
2.0.0 | 129,644 | 7/8/2022 |
2.0.0-SNAPSHOT-2 | 152 | 7/8/2022 |
2.0.0-SNAPSHOT | 158 | 6/29/2022 |
1.0.3 | 77,367 | 9/11/2020 |
1.0.2 | 1,028 | 11/15/2019 |