RedisMessagePipeline 1.0.1

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

// Install RedisMessagePipeline as a Cake Tool
#tool nuget:?package=RedisMessagePipeline&version=1.0.1                

Redis Message Pipeline

Overview

This Nuget package provides a robust solution for managing message pipelines with Redis. It ensures that each message is handled once and in order, with a focus on high reliability and consistency across distributed systems. The package is designed to handle failures gracefully, retrying message handling based on configurable policies or stopping the pipeline until manual intervention.

Features

  • Single Message Handling: Each message is processed individually to ensure order and consistency.
  • Failure Handling: Automatic retries or stops based on user-defined policies to manage message handling failures.
  • Pipeline Control: Administrative controls to stop, resume, or clean the pipeline, providing flexibility in managing message flow.

Getting Started

Installation

Install the package from Nuget:

dotnet add package RedisMessagePipeline

Configuration

Configure the Redis client and pipeline settings in your application:

Configure Services:

In your application's startup configuration, register RedisPipelineFactory:

public void ConfigureServices(IServiceCollection services)
{
    // Using an existing IConnectionMultiplexer instance:
    services.AddRedisPipelineFactory(settings);

    // Or, initiating a new IConnectionMultiplexer with a connection string:
    services.AddRedisPipelineFactory(redisConnectionString, settings);
}

Manually create Facroty with Redis Database and LockerFactory

ConnectionMultiplexer redis = ConnectionMultiplexer.Connect("localhost:6379");
RedLockMultiplexer lockMultiplexer = new RedLockMultiplexer(redis);
IDatabase db = redis.GetDatabase();

var loggerFactory = new LoggerFactory();
RedLockFactory lockFactory = RedLockFactory.Create(new List<RedLockMultiplexer> { lockMultiplexer });
RedisPipelineFactory factory = new RedisPipelineFactory(loggerFactory, lockFactory, db);

Create Admin and Consumer

var consumer = factory.CreateConsumer(new MyMessageHandler(), new RedisPipelineConsumerSettings("my-messages"));
var admin = factory.CreateAdmin(new RedisPipelineAdminSettings("my-messages"));

Usage

Administrate the pipeline:

// Stop the pipeline
await admin.StopAsync();

// Push messages
for (int i = 0; i < 10; i++)
{
    await admin.PushAsync($"message:{i}");
}

// Resume the pipeline, skipping problematic messages if necessary
await admin.ResumeAsync(1, CancellationToken.None);

Start the consumer to process messages:

await consumer.ExecuteAsync(CancellationToken.None);

License

Distributed under the MIT License. See LICENSE for more information.

Support

For support and contributions, please contact the package maintainer at coddicat@gmail.com.

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 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.0 299 4/19/2024
1.0.1 108 4/18/2024
1.0.0 89 4/18/2024