Incendium.RetryPolicy 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Incendium.RetryPolicy --version 1.0.0                
NuGet\Install-Package Incendium.RetryPolicy -Version 1.0.0                
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="Incendium.RetryPolicy" Version="1.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Incendium.RetryPolicy --version 1.0.0                
#r "nuget: Incendium.RetryPolicy, 1.0.0"                
#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 Incendium.RetryPolicy as a Cake Addin
#addin nuget:?package=Incendium.RetryPolicy&version=1.0.0

// Install Incendium.RetryPolicy as a Cake Tool
#tool nuget:?package=Incendium.RetryPolicy&version=1.0.0                

Incendium

License: MIT

Incendium is a small set of useful cross-platform .NET standard 2.1 libraries for .NET developers.

Package Description Nuget
Incendium.Result Contains Error, Result<T> and NullableResult<T> types which allows to return a success value or an error (something vaguely similar to the Rust style) <a href="https://www.nuget.org/packages/Incendium.Result/"><img src="https://img.shields.io/nuget/v/Incendium.Result"/></a><a href="https://www.nuget.org/packages/Incendium.Result/"><img src="https://img.shields.io/nuget/dt/Incendium.Result"/></a>
Incendium.RetryPolicy Provides RetryHttpClientHandler to easily retry HTTP requests in case of errors, as well as RateGate to control rate limiting <a href="https://www.nuget.org/packages/Incendium.RetryPolicy/"><img src="https://img.shields.io/nuget/v/Incendium.RetryPolicy"/></a><a href="https://www.nuget.org/packages/Incendium.RetryPolicy/"><img src="https://img.shields.io/nuget/dt/Incendium.RetryPolicy"/></a>

Getting started

Installation

PM> Install-Package Incendium.Result PM> Install-Package Incendium.RetryPolicy

Result<T> and NullableResult<T>

The method can be synchronous or asynchronous and can return a value without explicitly creating a Result<T> type:

public async Result<string> GetStringAsync() {
    // ...
    if (condition1) {
        return "Test string result";
    } else {
        return new Error(code: 123, message: "Test error");
    }

    try {
        // ...
    } catch (Exception e) {
        return new Error(code: 321, message: "Test error", exception: e);
    }
}

Then processing the result might look like this:

var (str, error) = await GetStringAsync();

if (error != null) {
    log.LogError(
        error.Exception(),
        "Error with code {@code} and message {@message}",
        error.Code(),
        error.Message());
}

RetryHttpClientHandler

Сan be used as a handler for HttpClient and allows you to easily (compared to Polly) set up repeated requests in the following cases:

  • HttpNetworkException
  • Server errors (5xx)
  • Request timeout error (408)
  • Too many requests (429)

and also allows you to configure rate limiting with exponential delays for outgoing requests using RateGate:

var innerHttpClientHandler = new HttpClientHandler(); // can be easily mocked
var retryHttpClientHandler = new RetryHttpClientHandler(innerHttpClientHandler)
{
    RetryCount = 5, // sets 5 retry attempts
    RetryOnHttpRequestException = true, // sets the retry flag in case of an HttpRequestException
    FirstRetryDelay = TimeSpan.FromMilliseconds(100), // sets the median starting delay between requests
    RateGate = new RateGate(
        occurrences: 10, // sets rate limit to 10 request per 60 seconds
        timeUnit: TimeSpan.FromSeconds(60))
}
var httpClient = new HttpClient(retryHttpClientHandler);

There are several ready-made delay algorithms that can be used:

  • Constant
  • Exponential
  • DecorrelatedJitterBackoffV2 (default)
var retryHttpClientHandler = new RetryHttpClientHandler(innerHttpClientHandler)
{
    RetryDelaysFactory = () => Delays.Exponential(
        firstDelay: TimeSpan.FromMilliseconds(100),
        count: 10)
}

You can also pass your own delay algorithm in the RetryDelaysFactory property, which should return IEnumerable<TimeSpan>.

Product 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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Incendium.RetryPolicy:

Package Downloads
Revelium.Evm

Revelium.Evm is .NET integration library for Etherlink and EVM-compatible networks

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.2 128 8/15/2024
1.0.1 107 8/12/2024
1.0.0 116 8/12/2024