Class ClusterSettings

This class represents configuration information used when setting up a cluster.

Inheritance

object

ClusterSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster

Assembly: Akka.Cluster.dll

Syntax

public sealed class ClusterSettings

Constructors

| Edit this page View Source

ClusterSettings(Config, string)

Initializes a new instance of the ClusterSettings class.

Declaration

public ClusterSettings(Config config, string systemName)

Parameters

Type	Name	Description
Config	config	The configuration to use when setting up the cluster.
string	systemName	The name of the actor system hosting the cluster.

Properties

| Edit this page View Source

AllowWeaklyUpMembers

If this is set to "off", the leader will not move Joining members to Up during a network split. This feature allows the leader to accept Joining members to be WeaklyUp so they become part of the cluster even during a network split.

The leader will move WeaklyUp members to Up status once convergence has been reached.

Declaration

public bool AllowWeaklyUpMembers { get; }

Property Value

Type	Description
bool

| Edit this page View Source

AppVersion

Application version

Declaration

public AppVersion AppVersion { get; }

Property Value

Type	Description
AppVersion

| Edit this page View Source

AutoDownUnreachableAfter

Obsolete. No longer used as of Akka.NET v1.5.

Declaration

[Obsolete("Deprecated as of Akka.NET v1.5.2 - clustering defaults to using KeepMajority SBR instead")]
public TimeSpan? AutoDownUnreachableAfter { get; }

Property Value

Type	Description
TimeSpan?

| Edit this page View Source

DowningProviderType

TBD

Declaration

public Type DowningProviderType { get; }

Property Value

Type	Description
Type

| Edit this page View Source

FailureDetectorConfig

The configuration for the underlying failure detector used by Akka.Cluster.

Declaration

public Config FailureDetectorConfig { get; }

Property Value

Type	Description
Config

| Edit this page View Source

FailureDetectorImplementationClass

The fully qualified type name of the failure detector class that will be used.

Declaration

public string FailureDetectorImplementationClass { get; }

Property Value

Type	Description
string

| Edit this page View Source

GossipDifferentViewProbability

TBD

Declaration

public double GossipDifferentViewProbability { get; }

Property Value

Type	Description
double

| Edit this page View Source

GossipInterval

The amount of time between when gossip messages are sent.

Declaration

public TimeSpan GossipInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

GossipTimeToLive

TBD

Declaration

public TimeSpan GossipTimeToLive { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

HeartbeatExpectedResponseAfter

The amount of time we expect a heartbeat response after first contact with a new node.

Declaration

public TimeSpan HeartbeatExpectedResponseAfter { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

HeartbeatInterval

The amount of time between when heartbeat messages are sent.

Declaration

public TimeSpan HeartbeatInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

LeaderActionsInterval

TBD

Declaration

public TimeSpan LeaderActionsInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

LogInfo

Determine whether to log InfoLevel messages.

Declaration

public bool LogInfo { get; }

Property Value

Type	Description
bool

| Edit this page View Source

LogInfoVerbose

Determine whether to log verbose InfoLevel messages for temporary troubleshooting.

Declaration

public bool LogInfoVerbose { get; }

Property Value

Type	Description
bool

| Edit this page View Source

MinNrOfMembers

TBD

Declaration

public int MinNrOfMembers { get; }

Property Value

Type	Description
int

| Edit this page View Source

MinNrOfMembersOfRole

TBD

Declaration

public ImmutableDictionary<string, int> MinNrOfMembersOfRole { get; }

Property Value

Type	Description
ImmutableDictionary<string, int>

| Edit this page View Source

MonitoredByNrOfMembers

TBD

Declaration

public int MonitoredByNrOfMembers { get; }

Property Value

Type	Description
int

| Edit this page View Source

PeriodicTasksInitialDelay

TBD

Declaration

public TimeSpan PeriodicTasksInitialDelay { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

PublishStatsInterval

TBD

Declaration

public TimeSpan? PublishStatsInterval { get; }

Property Value

Type	Description
TimeSpan?

| Edit this page View Source

ReduceGossipDifferentViewProbability

TBD

Declaration

public int ReduceGossipDifferentViewProbability { get; }

Property Value

Type	Description
int

| Edit this page View Source

RetryUnsuccessfulJoinAfter

TBD

Declaration

public TimeSpan? RetryUnsuccessfulJoinAfter { get; }

Property Value

Type	Description
TimeSpan?

| Edit this page View Source

Roles

TBD

Declaration

public ImmutableHashSet<string> Roles { get; }

Property Value

Type	Description
ImmutableHashSet<string>

| Edit this page View Source

RunCoordinatedShutdownWhenDown

Trigger the CoordinatedShutdown even if this node was removed by non-graceful means, such as being downed.

Declaration

public bool RunCoordinatedShutdownWhenDown { get; }

Property Value

Type	Description
bool

| Edit this page View Source

SchedulerTickDuration

TBD

Declaration

public TimeSpan SchedulerTickDuration { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

SchedulerTicksPerWheel

TBD

Declaration

public int SchedulerTicksPerWheel { get; }

Property Value

Type	Description
int

| Edit this page View Source

SeedNodeTimeout

TBD

Declaration

public TimeSpan SeedNodeTimeout { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

SeedNodes

A list of designated seed nodes for the cluster.

Declaration

public ImmutableList<Address> SeedNodes { get; }

Property Value

Type	Description
ImmutableList<Address>

| Edit this page View Source

ShutdownAfterUnsuccessfulJoinSeedNodes

TBD

Declaration

public TimeSpan? ShutdownAfterUnsuccessfulJoinSeedNodes { get; }

Property Value

Type	Description
TimeSpan?

| Edit this page View Source

UnreachableNodesReaperInterval

TBD

Declaration

public TimeSpan UnreachableNodesReaperInterval { get; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

UseDispatcher

TBD

Declaration

public string UseDispatcher { get; }

Property Value

Type	Description
string

| Edit this page View Source

UseLegacyHeartbeatMessage

Enable/disable legacy pre-1.4.19 Akka.Cluster.ClusterHeartbeatSender.Heartbeat and Akka.Cluster.ClusterHeartbeatSender.HeartbeatRsp wire format serialization support. Set this to true if you're doing a rolling update from Akka.NET version older than 1.4.19.

Declaration

public bool UseLegacyHeartbeatMessage { get; }

Property Value

Type	Description
bool

| Edit this page View Source

VerboseGossipReceivedLogging

Determines whether or not to log gossip consumption logging in verbose mode

Declaration

public bool VerboseGossipReceivedLogging { get; }

Property Value

Type	Description
bool

| Edit this page View Source

VerboseHeartbeatLogging

Determine whether or not to log heartbeat message in verbose mode.

Declaration

public bool VerboseHeartbeatLogging { get; }

Property Value

Type	Description
bool

| Edit this page View Source

WeaklyUpAfter

The duration after which a member who is currently Joining will be marked as WeaklyUp in the event that members of the cluster are currently unreachable.

This is designed to allow new cluster members to perform work even in the event of a cluster split.

The leader will move WeaklyUp members to Up status once convergence has been reached.

Declaration

public TimeSpan WeaklyUpAfter { get; }

Property Value

Type	Description
TimeSpan

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)