Akka.Persistence.Redis.Hosting 1.5.29

Akka.Persistence.Redis.Hosting

Akka.Hosting extension methods to add Akka.Persistence.Redis to an ActorSystem

Akka.Persistence.Redis Extension Methods

WithRedisPersistence() Method

public static AkkaConfigurationBuilder WithRedisPersistence(
    this AkkaConfigurationBuilder builder,
    string configurationString,
    PersistenceMode mode = PersistenceMode.Both,
    bool autoInitialize = true,
    Action<AkkaPersistenceJournalBuilder>? journalBuilder = null,
    string pluginIdentifier = "Redis",
    bool isDefaultPlugin = true);

public static AkkaConfigurationBuilder WithRedisPersistence(
    this AkkaConfigurationBuilder builder,
    Action<RedisJournalOptions>? journalOptionConfigurator = null,
    Action<RedisSnapshotOptions>? snapshotOptionConfigurator = null,
    bool isDefaultPlugin = true)

public static AkkaConfigurationBuilder WithRedisPersistence(
    this AkkaConfigurationBuilder builder,
    RedisJournalOptions? journalOptions = null,
    RedisSnapshotOptions? snapshotOptions = null)

Parameters

• configurationString string

  Connection string used for database access. Connection string as described here: https://stackexchange.github.io/StackExchange.Redis/Configuration#basic-configuration-strings.

• mode PersistenceMode

  Determines which settings should be added by this method call. Default: PersistenceMode.Both

  • PersistenceMode.Journal: Only add the journal settings
  • PersistenceMode.SnapshotStore: Only add the snapshot store settings
  • PersistenceMode.Both: Add both journal and snapshot store settings

• autoInitialize bool

  Should the Redis store collection be initialized automatically. Default: false

• journalBuilder Action<AkkaPersistenceJournalBuilder>

  An Action delegate used to configure an AkkaPersistenceJournalBuilder instance. Used to configure Event Adapters

• journalConfigurator Action<RedisJournalOptions>

  An Action delegate to configure a RedisJournalOptions instance.

• snapshotConfigurator Action<RedisSnapshotOptions>

  An Action delegate to configure a RedisSnapshotOptions instance.

• journalOptions RedisJournalOptions

  An RedisJournalOptions instance to configure the Redis journal store.

• snapshotOptions RedisSnapshotOptions

  An RedisSnapshotOptions instance to configure the Redis snapshot store.

Example

using var host = new HostBuilder()
    .ConfigureServices((context, services) =>
    {
        services.AddAkka("redisDemo", (builder, provider) =>
        {
            builder
                .WithRedisPersistence("your-redis-connection-string");
        });
    }).Build();

await host.RunAsync();