Microsoft.Orleans.Reminders.Redis 9.2.0-preview3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Orleans.Reminders.Redis. 
dotnet add package Microsoft.Orleans.Reminders.Redis --version 9.2.0-preview3
                    


                    

                
NuGet\Install-Package Microsoft.Orleans.Reminders.Redis -Version 9.2.0-preview3
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="Microsoft.Orleans.Reminders.Redis" Version="9.2.0-preview3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Microsoft.Orleans.Reminders.Redis" Version="9.2.0-preview3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Microsoft.Orleans.Reminders.Redis" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Microsoft.Orleans.Reminders.Redis --version 9.2.0-preview3
                    


                    

                
#r "nuget: Microsoft.Orleans.Reminders.Redis, 9.2.0-preview3"
#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. 
#addin nuget:?package=Microsoft.Orleans.Reminders.Redis&version=9.2.0-preview3&prerelease
                    


                            Install Microsoft.Orleans.Reminders.Redis as a Cake Addin
                        

                    

                
#tool nuget:?package=Microsoft.Orleans.Reminders.Redis&version=9.2.0-preview3&prerelease
                    


                            Install Microsoft.Orleans.Reminders.Redis as a Cake Tool

Microsoft Orleans Reminders for Redis

Introduction

Microsoft Orleans Reminders for Redis provides persistence for Orleans reminders using Redis. This allows your Orleans applications to schedule persistent reminders that will be triggered even after silo restarts or grain deactivation.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Reminders.Redis

Example - Configuring Redis Reminders

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering()
            // Configure Redis as reminder storage
            .UseRedisReminderService(options =>
            {
                options.ConnectionString = "localhost:6379";
                options.Database = 0;
                options.KeyPrefix = "reminder-"; // Optional prefix for Redis keys
            });
    });

// Run the host
await builder.RunAsync();

Example - Using Reminders in a Grain

public class ReminderGrain : Grain, IReminderGrain, IRemindable
{
    private string _reminderName = "MyReminder";

    public async Task StartReminder(string reminderName)
    {
        _reminderName = reminderName;
        
        // Register a persistent reminder
        await RegisterOrUpdateReminder(
            reminderName,
            TimeSpan.FromMinutes(2),  // Time to delay before the first tick (must be > 1 minute)
            TimeSpan.FromMinutes(5)); // Period of the reminder (must be > 1 minute)
    }

    public async Task StopReminder()
    {
        // Find and unregister the reminder
        var reminder = await GetReminder(_reminderName);
        if (reminder != null)
        {
            await UnregisterReminder(reminder);
        }
    }

    public Task ReceiveReminder(string reminderName, TickStatus status)
    {
        // This method is called when the reminder ticks
        Console.WriteLine($"Reminder {reminderName} triggered at {DateTime.UtcNow}. Status: {status}");
        return Task.CompletedTask;
    }
}

Documentation

For more comprehensive documentation, please refer to:

Feedback & Contributing

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Microsoft.Orleans.Reminders.Redis:

Package Downloads
Cszy.Orleans

Package Description
SiloX.Orleans.Reminders.Redis

Redis reminders module that for Microsoft Orleans.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.2.0-preview3 285 6/10/2025
9.2.0-preview2 170 6/4/2025
9.2.0-preview1 1,305 4/4/2025
9.1.2 18,294 2/13/2025
9.0.1 15,565 11/23/2024
9.0.0 1,754 11/14/2024
8.2.0 33,095 7/12/2024
8.2.0-preview1 565 5/22/2024
8.1.0 14,581 4/17/2024
8.1.0-preview3 124 3/11/2024
8.1.0-preview2 107 2/23/2024
8.1.0-preview1 114 2/13/2024
8.0.0 7,632 1/5/2024
8.0.0-rc2 415 12/20/2023
8.0.0-rc1 267 12/4/2023
7.2.7 902 10/15/2024
7.2.6 1,929 3/9/2024
7.2.5 1,660 2/22/2024
7.2.4 6,745 12/2/2023
7.2.3 2,339 11/3/2023
7.2.2 18,872 10/16/2023
7.2.1 10,873 7/11/2023
7.2.0 598 7/7/2023
7.1.2-beta1 643 4/19/2023
7.1.1-beta1 297 3/23/2023
7.1.0-beta1 396 2/1/2023