Class ClusterSingletonSettings

The settings used for the ClusterSingleton

Inheritance
object
ClusterSingletonSettings
Implements
Inherited Members
Namespace: Akka.Cluster.Tools.Singleton
Assembly: Akka.Cluster.Tools.dll
Syntax
[Serializable]
[Obsolete("This setting class is deprecated and will be removed in v1.6, please use ClusterSingletonManager.Props and ClusterSingletonProxy.Props directly instead. See https://getakka.net/community/whats-new/akkadotnet-v1.5-upgrade-advisories.html#upgrading-to-akkanet-v1532. Since 1.5.32.")]
public class ClusterSingletonSettings : INoSerializationVerificationNeeded

Properties

| Edit this page View Source

BufferSize

If the location of the singleton is unknown the proxy will buffer this number of messages and deliver them when the singleton is identified. When the buffer is full old messages will be dropped when new messages are sent viea the proxy. Use 0 to disable buffering, i.e. messages will be dropped immediately if the location of the singleton is unknown.

Declaration
public int BufferSize { get; }
Property Value
Type Description
int
| Edit this page View Source

ConsiderAppVersion

Should AppVersion be considered when the cluster singleton instance is being moved to another node. When set to false, singleton instance will always be created on oldest member. When set to true, singleton instance will be created on the oldest member with the highest AppVersion number.

Declaration
public bool ConsiderAppVersion { get; }
Property Value
Type Description
bool
| Edit this page View Source

HandOverRetryInterval

When a node is becoming oldest it sends hand-over request to previous oldest, that might be leaving the cluster. This is retried with this interval until the previous oldest confirms that the hand over has started or the previous oldest member is removed from the cluster (+ removalMargin).

Declaration
public TimeSpan HandOverRetryInterval { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

LeaseSettings

LeaseSettings for acquiring before creating the singleton actor.

Declaration
public LeaseUsageSettings LeaseSettings { get; }
Property Value
Type Description
LeaseUsageSettings
| Edit this page View Source

LogSingletonIdentificationFailure

Should the singleton proxy publish a warning if no singleton actor were found after a period of time

Declaration
public bool LogSingletonIdentificationFailure { get; }
Property Value
Type Description
bool
| Edit this page View Source

RemovalMargin

Margin until the singleton instance that belonged to a downed/removed partition is created in surviving partition. The purpose of this margin is that in case of a network partition the singleton actors in the non-surviving partitions must be stopped before corresponding actors are started somewhere else. This is especially important for persistent actors.

Declaration
public TimeSpan RemovalMargin { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

Role

Singleton among the nodes tagged with specified role. If the role is not specified it's a singleton among all nodes in the cluster.

Declaration
public string Role { get; }
Property Value
Type Description
string
| Edit this page View Source

SingletonIdentificationFailurePeriod

The period the proxy will wait until it logs a missing singleton warning, defaults to 1 minute

Declaration
public TimeSpan SingletonIdentificationFailurePeriod { get; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

SingletonIdentificationInterval

Interval at which the proxy will try to resolve the singleton instance.

Declaration
public TimeSpan SingletonIdentificationInterval { get; }
Property Value
Type Description
TimeSpan

Methods

| Edit this page View Source

Create(ActorSystem)

Create settings from the default configuration akka.cluster.

Declaration
public static ClusterSingletonSettings Create(ActorSystem system)
Parameters
Type Name Description
ActorSystem system
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

Create(Config)

Create settings from a configuration with the same layout as the default configuration akka.cluster.singleton and akka.cluster.singleton-proxy.

Declaration
public static ClusterSingletonSettings Create(Config config)
Parameters
Type Name Description
Config config
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
| Edit this page View Source

WithBufferSize(int)

Declaration
public ClusterSingletonSettings WithBufferSize(int bufferSize)
Parameters
Type Name Description
int bufferSize
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithHandOverRetryInterval(TimeSpan)

Declaration
public ClusterSingletonSettings WithHandOverRetryInterval(TimeSpan handOverRetryInterval)
Parameters
Type Name Description
TimeSpan handOverRetryInterval
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithLeaseSettings(LeaseUsageSettings)

Declaration
public ClusterSingletonSettings WithLeaseSettings(LeaseUsageSettings leaseSettings)
Parameters
Type Name Description
LeaseUsageSettings leaseSettings
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithLogSingletonIdentificationFailure(bool)

Declaration
public ClusterSingletonSettings WithLogSingletonIdentificationFailure(bool logSingletonIdentificationFailure)
Parameters
Type Name Description
bool logSingletonIdentificationFailure
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithRemovalMargin(TimeSpan)

Declaration
public ClusterSingletonSettings WithRemovalMargin(TimeSpan removalMargin)
Parameters
Type Name Description
TimeSpan removalMargin
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithRole(string)

Declaration
public ClusterSingletonSettings WithRole(string role)
Parameters
Type Name Description
string role
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithSingletonIdentificationFailurePeriod(TimeSpan)

Declaration
public ClusterSingletonSettings WithSingletonIdentificationFailurePeriod(TimeSpan singletonIdentificationFailurePeriod)
Parameters
Type Name Description
TimeSpan singletonIdentificationFailurePeriod
Returns
Type Description
ClusterSingletonSettings
| Edit this page View Source

WithSingletonIdentificationInterval(TimeSpan)

Declaration
public ClusterSingletonSettings WithSingletonIdentificationInterval(TimeSpan singletonIdentificationInterval)
Parameters
Type Name Description
TimeSpan singletonIdentificationInterval
Returns
Type Description
ClusterSingletonSettings

Implements

Extension Methods