Overview

This library does not intend to replace the System.Threading.RateLimiting Namespace. Simply make working with some aspects of it easier under some contexts.

Extension Methods

ConcurrentQueue<T>

Processing a ConcurrentQueue will continue until the cancellation token is cancelled or the queue is empty allowing for work to add more work which will be completed.

ProcessWithTPSAsync()

This abtraction calls TokenBucketRateLimiter with options designed to keep the calls to this function below a set Transactions Per Second by using assumptions.

This call does not attmpet to keep the throughput at the set TPS, but will ensure it will not go over that set amount. In testing TPS can only be reached with a high concurrency value.

Concurrency does not directly imply the number of threas as that depends on how the work is performed within the callback. General guidance is to set concurrency proprotational to the complexity of the call, lower values for callbacks that complete quickly, larger for callbacks that require more time.

Example Call:

var stringQueue = new ConcurrentQueue<string>();
// Fill the queue
await stringQueue.ProcessWithTPSAsync(100, 10, async (action) =>
{
    // Perform work once TPS falls below the threshold
});

The above configuration will execute 10 concurrent tasks executing no more than 100 per second.

ProcessWithRateLimitAsync()

This abstraction resides just above the TokenBucketRateLimiter exposing most of the core API with added clarity to the options.

If processing of the queue is intended to be handled by multiple threads or further tuning of the delegation to worker threads, this extension is more appropriate to use.

Example Call:

var stringQueue = new ConcurrentQueue<string>();
// Fill the queue
await stringQueue.ProcessWithRateLimitAsync(new ThroughputConcurrencyOptions()
{
    ConcurrencyLimit = 20,
    ReplinshmentPeriod = TimeSpan.FromSeconds(10),
    TasksPerPeriod = 50
}, async (value) =>
{
    // Do work
});

The above configuration will pop tasks off of the queue keeping 20 active at a time, blocking once 50 tasks have been completed within a 10 second period.