Soenneker.Utils.RateLimiting.Executor 3.0.50

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Soenneker.Utils.RateLimiting.Executor --version 3.0.50                
NuGet\Install-Package Soenneker.Utils.RateLimiting.Executor -Version 3.0.50                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Soenneker.Utils.RateLimiting.Executor" Version="3.0.50" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Soenneker.Utils.RateLimiting.Executor --version 3.0.50                
#r "nuget: Soenneker.Utils.RateLimiting.Executor, 3.0.50"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Soenneker.Utils.RateLimiting.Executor as a Cake Addin
#addin nuget:?package=Soenneker.Utils.RateLimiting.Executor&version=3.0.50

// Install Soenneker.Utils.RateLimiting.Executor as a Cake Tool
#tool nuget:?package=Soenneker.Utils.RateLimiting.Executor&version=3.0.50                

alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

alternate text is missing from this package README image Soenneker.Utils.RateLimiting.Executor

A thread-safe utility designed to manage the rate at which tasks are executed, ensuring they are not run more frequently than a specified interval.

RateLimitingExecutor is ideal for interacting with rate-limited APIs or throttling the execution of resource-intensive tasks.

Sequential Execution

Tasks, ValueTasks, and Actions are executed one at a time. If the defined interval between executions has passed, the task runs immediately; otherwise, it waits until the interval elapses before proceeding.

⚠️ Important Notes:

  • This is not a background queue processor. Each method awaits the result of the asynchronous operation before continuing.

  • Asynchronous methods will not block the calling thread, but synchronous methods will block execution until it completes.

Want to use this with dependency injection?

Check out the singleton factory implementation: Soenneker.Utils.RateLimiting.Factory

Installation

dotnet add package Soenneker.Utils.RateLimiting.Executor

Example: Executing a Loop of Tasks with Rate Limiting

Below is an example demonstrating how to use the RateLimitingExecutor to execute a series of tasks while maintaining a rate limit.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Soenneker.Utils.RateLimiting.Executor;

public class Program
{
    public static async Task Main(string[] args)
    {
        var rateLimitingExecutor = new RateLimitingExecutor(TimeSpan.FromSeconds(2));

        for (int i = 0; i < 5; i++)
        {
            await rateLimitingExecutor.Execute(async ct =>
            {
                Console.WriteLine($"Executing Task {i + 1} at {DateTime.Now:HH:mm:ss}");
                await Task.Delay(100); // Simulate some work
            });
        }
    }
}

Console Output

Executing Task 1 at 14:00:00
Executing Task 2 at 14:00:02
Executing Task 3 at 14:00:04
Executing Task 4 at 14:00:06
Executing Task 5 at 14:00:08
Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Soenneker.Utils.RateLimiting.Executor:

Package Downloads
Soenneker.Utils.RateLimiting.Factory

An async thread-safe singleton dictionary for Soenneker.Utils.RateLimiting.Executors, designed to manage the rate at which tasks are executed.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.61 61 11/21/2024
3.0.60 46 11/21/2024
3.0.59 143 11/20/2024
3.0.58 68 11/20/2024
3.0.57 88 11/20/2024
3.0.56 72 11/20/2024
3.0.55 73 11/20/2024
3.0.54 86 11/20/2024
3.0.53 80 11/19/2024
3.0.52 67 11/19/2024
3.0.51 66 11/19/2024
3.0.50 236 11/19/2024
3.0.49 62 11/19/2024
3.0.48 202 11/19/2024
3.0.47 66 11/19/2024
3.0.46 66 11/19/2024
3.0.45 256 11/15/2024
3.0.44 112 11/14/2024
3.0.43 63 11/14/2024
3.0.42 63 11/14/2024
3.0.41 113 11/14/2024
3.0.40 79 11/14/2024
3.0.39 191 11/14/2024
3.0.38 286 11/14/2024
3.0.37 128 11/14/2024
3.0.36 63 11/14/2024
3.0.35 65 11/14/2024
3.0.34 110 11/14/2024
3.0.33 66 11/14/2024
3.0.32 164 11/14/2024
2.1.31 267 11/13/2024
2.1.30 151 11/13/2024
2.1.29 224 11/13/2024
2.1.28 115 11/12/2024
2.1.27 58 11/12/2024
2.1.26 493 11/9/2024
2.1.25 152 11/9/2024
2.1.24 314 11/8/2024
2.1.23 74 11/8/2024
2.1.22 70 11/8/2024
2.1.21 263 11/8/2024
2.1.20 207 11/8/2024
2.1.19 228 11/6/2024
2.1.18 306 11/1/2024
2.1.17 67 11/1/2024
2.1.16 296 11/1/2024
2.1.14 81 10/29/2024
2.1.13 232 10/29/2024
2.1.12 120 10/29/2024
2.1.11 389 10/29/2024
2.1.10 230 10/28/2024
2.1.9 66 10/28/2024
2.1.8 95 10/28/2024
2.1.7 331 10/26/2024
2.1.6 90 10/26/2024
2.1.5 238 10/22/2024
2.1.4 95 10/22/2024
2.1.3 70 10/22/2024
2.1.2 81 10/22/2024
2.1.1 97 10/22/2024