Class ShardedDaemonProcessSettings

Inheritance
object
ShardedDaemonProcessSettings
Inherited Members
Namespace: Akka.Cluster.Sharding
Assembly: Akka.Cluster.Sharding.dll
Syntax
[Serializable]
public sealed class ShardedDaemonProcessSettings

Fields

| Edit this page View Source

KeepAliveInterval

The interval each parent of the sharded set is pinged from each node in the cluster.

Declaration
public readonly TimeSpan KeepAliveInterval
Field Value
Type Description
TimeSpan
| Edit this page View Source

Role

Specifies that the ShardedDaemonProcess should run on nodes with a specific role.

Declaration
public readonly string? Role
Field Value
Type Description
string
| Edit this page View Source

ShardingSettings

Specify sharding settings that should be used for the sharded daemon process instead of loading from config.

Declaration
public readonly ClusterShardingSettings? ShardingSettings
Field Value
Type Description
ClusterShardingSettings

Methods

| Edit this page View Source

Create(ActorSystem)

Create default settings for system

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

FromConfig(Config)

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

WithKeepAliveInterval(TimeSpan)

NOTE: How the sharded set is kept alive may change in the future meaning this setting may go away.

Declaration
public ShardedDaemonProcessSettings WithKeepAliveInterval(TimeSpan keepAliveInterval)
Parameters
Type Name Description
TimeSpan keepAliveInterval

The interval each parent of the sharded set is pinged from each node in the cluster.
Returns
Type Description
ShardedDaemonProcessSettings
| Edit this page View Source

WithRole(string)

Specifies that the ShardedDaemonProcess should run on nodes with a specific role. If the role is not specified all nodes in the cluster are used. If the given role does not match the role of the current node the ShardedDaemonProcess will not be started.

Declaration
public ShardedDaemonProcessSettings WithRole(string role)
Parameters
Type Name Description
string role

TBD
Returns
Type Description
ShardedDaemonProcessSettings
| Edit this page View Source

WithShardingSettings(ClusterShardingSettings)

Specify sharding settings that should be used for the sharded daemon process instead of loading from config. Some settings can not be changed (remember-entities and related settings, passivation, number-of-shards), changing those settings will be ignored.

Declaration
public ShardedDaemonProcessSettings WithShardingSettings(ClusterShardingSettings shardingSettings)
Parameters
Type Name Description
ClusterShardingSettings shardingSettings

TBD
Returns
Type Description
ShardedDaemonProcessSettings

Extension Methods