[Obsolete("Use constructor with `verboseDebugLogging` argument. Obsolete since v1.5.0-alpha2")]
public ReplicatorSettings(string role, TimeSpan gossipInterval, TimeSpan notifySubscribersInterval, int maxDeltaElements, string dispatcher, TimeSpan pruningInterval, TimeSpan maxPruningDissemination, IImmutableSet<string> durableKeys, Props durableStoreProps, TimeSpan pruningMarkerTimeToLive, TimeSpan durablePruningMarkerTimeToLive, int maxDeltaSize, bool restartReplicatorOnFailure, bool preferOldest)

Parameters

Type	Name	Description
string	role
TimeSpan	gossipInterval
TimeSpan	notifySubscribersInterval
int	maxDeltaElements
string	dispatcher
TimeSpan	pruningInterval
TimeSpan	maxPruningDissemination
IImmutableSet<string>	durableKeys
Props	durableStoreProps
TimeSpan	pruningMarkerTimeToLive
TimeSpan	durablePruningMarkerTimeToLive
int	maxDeltaSize
bool	restartReplicatorOnFailure
bool	preferOldest

| Edit this page View Source

ReplicatorSettings(string, TimeSpan, TimeSpan, int, string, TimeSpan, TimeSpan, IImmutableSet<string>, Props, TimeSpan, TimeSpan, int, bool, bool, bool)

Declaration

public ReplicatorSettings(string role, TimeSpan gossipInterval, TimeSpan notifySubscribersInterval, int maxDeltaElements, string dispatcher, TimeSpan pruningInterval, TimeSpan maxPruningDissemination, IImmutableSet<string> durableKeys, Props durableStoreProps, TimeSpan pruningMarkerTimeToLive, TimeSpan durablePruningMarkerTimeToLive, int maxDeltaSize, bool restartReplicatorOnFailure, bool preferOldest, bool verboseDebugLogging)

Parameters

Type	Name	Description
string	role
TimeSpan	gossipInterval
TimeSpan	notifySubscribersInterval
int	maxDeltaElements
string	dispatcher
TimeSpan	pruningInterval
TimeSpan	maxPruningDissemination
IImmutableSet<string>	durableKeys
Props	durableStoreProps
TimeSpan	pruningMarkerTimeToLive
TimeSpan	durablePruningMarkerTimeToLive
int	maxDeltaSize
bool	restartReplicatorOnFailure
bool	preferOldest
bool	verboseDebugLogging

Properties

| Edit this page View Source

Dispatcher

Id of the dispatcher to use for Replicator actors. If not specified the default dispatcher is used.

Declaration

public string Dispatcher { get; }

Property Value

Type	Description
string

| Edit this page View Source

DurableKeys

Keys that are durable. Prefix matching is supported by using * at the end of a key. All entries can be made durable by including "*" in the Set.

Declaration

public IImmutableSet<string> DurableKeys { get; }

Property Value

Type	Description
IImmutableSet<string>

| Edit this page View Source

DurablePruningMarkerTimeToLive

Declaration

public TimeSpan DurablePruningMarkerTimeToLive { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

DurableStoreProps

Props for the durable store actor, when taken from actor class type name, it requires its constructor to take Config as constructor parameter.

Declaration

public Props DurableStoreProps { get; }

Property Value

Type	Description
Props

| Edit this page View Source

GossipInterval

How often the Replicator should send out gossip information.

Declaration

public TimeSpan GossipInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

IsDurable

Determines if a durable store has been configured and is used. If configuration has defined some durable keys, this field must be true.

Declaration

public bool IsDurable { get; }

Property Value

Type	Description
bool

| Edit this page View Source

MaxDeltaElements

Maximum number of entries to transfer in one gossip message when synchronizing the replicas.Next chunk will be transferred in next round of gossip.

Declaration

public int MaxDeltaElements { get; }

Property Value

Type	Description
int

| Edit this page View Source

MaxDeltaSize

Declaration

public int MaxDeltaSize { get; }

Property Value

Type	Description
int

| Edit this page View Source

MaxPruningDissemination

How long time it takes (worst case) to spread the data to all other replica nodes. This is used when initiating and completing the pruning process of data associated with removed cluster nodes. The time measurement is stopped when any replica is unreachable, so it should be configured to worst case in a healthy cluster.

Declaration

public TimeSpan MaxPruningDissemination { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

NotifySubscribersInterval

How often the subscribers will be notified of changes, if any.

Declaration

public TimeSpan NotifySubscribersInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

PreferOldest

Update and Get operations are sent to oldest nodes first.

Declaration

public bool PreferOldest { get; }

Property Value

Type	Description
bool

| Edit this page View Source

PruningInterval

How often the Replicator checks for pruning of data associated with removed cluster nodes.

Declaration

public TimeSpan PruningInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

PruningMarkerTimeToLive

How long the tombstones of a removed node are kept on their CRDTs.

Declaration

public TimeSpan PruningMarkerTimeToLive { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

RestartReplicatorOnFailure

Declaration

public bool RestartReplicatorOnFailure { get; }

Property Value

Type	Description
bool

| Edit this page View Source

Role

Replicas are running on members tagged with this role. All members are used if undefined.

Declaration

public string Role { get; }

Property Value

Type	Description
string

| Edit this page View Source

VerboseDebugLogging

Whether verbose debug logging is enabled.

Declaration

public bool VerboseDebugLogging { get; }

Property Value

Type	Description
bool

Methods

| Edit this page View Source

Create(ActorSystem)

Create settings from the default configuration akka.cluster.distributed-data.

Declaration

public static ReplicatorSettings Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	TBD

Returns

Type	Description
ReplicatorSettings	TBD

| Edit this page View Source

Create(Config)

Create settings from a configuration with the same layout as the default configuration akka.cluster.distributed-data.

Declaration

public static ReplicatorSettings Create(Config config)

Parameters

Type	Name	Description
Config	config	TBD

Returns

Type	Description
ReplicatorSettings	TBD

Exceptions

Type	Condition
ArgumentNullException	TBD

| Edit this page View Source

WithDispatcher(string)

Declaration

public ReplicatorSettings WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
string	dispatcher

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithDurableKeys(IImmutableSet<string>)

Declaration

public ReplicatorSettings WithDurableKeys(IImmutableSet<string> durableKeys)

Parameters

Type	Name	Description
IImmutableSet<string>	durableKeys

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithDurableStoreProps(Props)

Declaration

public ReplicatorSettings WithDurableStoreProps(Props durableStoreProps)

Parameters

Type	Name	Description
Props	durableStoreProps

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithGossipInterval(TimeSpan)

Declaration

public ReplicatorSettings WithGossipInterval(TimeSpan gossipInterval)

Parameters

Type	Name	Description
TimeSpan	gossipInterval

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithMaxDeltaElements(int)

Declaration

public ReplicatorSettings WithMaxDeltaElements(int maxDeltaElements)

Parameters

Type	Name	Description
int	maxDeltaElements

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithMaxDeltaSize(int)

Declaration

public ReplicatorSettings WithMaxDeltaSize(int maxDeltaSize)

Parameters

Type	Name	Description
int	maxDeltaSize

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithNotifySubscribersInterval(TimeSpan)

Declaration

public ReplicatorSettings WithNotifySubscribersInterval(TimeSpan notifySubscribersInterval)

Parameters

Type	Name	Description
TimeSpan	notifySubscribersInterval

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithPreferOldest(bool)

Declaration

public ReplicatorSettings WithPreferOldest(bool preferOldest)

Parameters

Type	Name	Description
bool	preferOldest

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithPruning(TimeSpan, TimeSpan)

Declaration

public ReplicatorSettings WithPruning(TimeSpan pruningInterval, TimeSpan maxPruningDissemination)

Parameters

Type	Name	Description
TimeSpan	pruningInterval
TimeSpan	maxPruningDissemination

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithPruningMarkerTimeToLive(TimeSpan, TimeSpan)

Declaration

public ReplicatorSettings WithPruningMarkerTimeToLive(TimeSpan pruningMarkerTtl, TimeSpan durablePruningMarkerTtl)

Parameters

Type	Name	Description
TimeSpan	pruningMarkerTtl
TimeSpan	durablePruningMarkerTtl

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithRestartReplicatorOnFailure(bool)

Declaration

public ReplicatorSettings WithRestartReplicatorOnFailure(bool restart)

Parameters

Type	Name	Description
bool	restart

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithRole(string)

Declaration

public ReplicatorSettings WithRole(string role)

Parameters

Type	Name	Description
string	role

Returns

Type	Description
ReplicatorSettings

| Edit this page View Source

WithVerboseDebugLogging(bool)

Declaration

public ReplicatorSettings WithVerboseDebugLogging(bool verboseDebugLogging)

Parameters

Type	Name	Description
bool	verboseDebugLogging

Returns

Type	Description
ReplicatorSettings

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)