Class ClusterShardingSettings

TBD

Inheritance

object

ClusterShardingSettings

Implements

INoSerializationVerificationNeeded

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Cluster.Sharding

Assembly: Akka.Cluster.Sharding.dll

Syntax

[Serializable]
public sealed class ClusterShardingSettings : INoSerializationVerificationNeeded

Constructors

| Edit this page View Source

ClusterShardingSettings(string, bool, string, string, TimeSpan, StateStoreMode, RememberEntitiesStore, TimeSpan, TuningParameters, ClusterSingletonManagerSettings, LeaseUsageSettings)

TBD

Declaration

public ClusterShardingSettings(string role, bool rememberEntities, string journalPluginId, string snapshotPluginId, TimeSpan passivateIdleEntityAfter, StateStoreMode stateStoreMode, RememberEntitiesStore rememberEntitiesStore, TimeSpan shardRegionQueryTimeout, TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings, LeaseUsageSettings leaseSettings)

Parameters

Type	Name	Description
string	role	TBD
bool	rememberEntities	TBD
string	journalPluginId	TBD
string	snapshotPluginId	TBD
TimeSpan	passivateIdleEntityAfter	TBD
StateStoreMode	stateStoreMode	TBD
RememberEntitiesStore	rememberEntitiesStore	TBD
TimeSpan	shardRegionQueryTimeout	TBD
TuningParameters	tuningParameters	TBD
ClusterSingletonManagerSettings	coordinatorSingletonSettings	TBD
LeaseUsageSettings	leaseSettings	TBD

| Edit this page View Source

ClusterShardingSettings(string, bool, string, string, TimeSpan, StateStoreMode, TuningParameters, ClusterSingletonManagerSettings)

TBD

Declaration

public ClusterShardingSettings(string role, bool rememberEntities, string journalPluginId, string snapshotPluginId, TimeSpan passivateIdleEntityAfter, StateStoreMode stateStoreMode, TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings)

Parameters

Type	Name	Description
string	role	TBD
bool	rememberEntities	TBD
string	journalPluginId	TBD
string	snapshotPluginId	TBD
TimeSpan	passivateIdleEntityAfter	TBD
StateStoreMode	stateStoreMode	TBD
TuningParameters	tuningParameters	TBD
ClusterSingletonManagerSettings	coordinatorSingletonSettings	TBD

| Edit this page View Source

ClusterShardingSettings(string, bool, string, string, TimeSpan, StateStoreMode, TuningParameters, ClusterSingletonManagerSettings, LeaseUsageSettings)

TBD

Declaration

public ClusterShardingSettings(string role, bool rememberEntities, string journalPluginId, string snapshotPluginId, TimeSpan passivateIdleEntityAfter, StateStoreMode stateStoreMode, TuningParameters tuningParameters, ClusterSingletonManagerSettings coordinatorSingletonSettings, LeaseUsageSettings leaseSettings)

Parameters

Type	Name	Description
string	role	TBD
bool	rememberEntities	TBD
string	journalPluginId	TBD
string	snapshotPluginId	TBD
TimeSpan	passivateIdleEntityAfter	TBD
StateStoreMode	stateStoreMode	TBD
TuningParameters	tuningParameters	TBD
ClusterSingletonManagerSettings	coordinatorSingletonSettings	TBD
LeaseUsageSettings	leaseSettings	TBD

Fields

| Edit this page View Source

CoordinatorSingletonSettings

TBD

Declaration

public readonly ClusterSingletonManagerSettings CoordinatorSingletonSettings

Field Value

Type	Description
ClusterSingletonManagerSettings

| Edit this page View Source

JournalPluginId

Absolute path to the journal plugin configuration entity that is to be used for the internal persistence of ClusterSharding.If not defined the default journal plugin is used. Note that this is not related to persistence used by the entity actors.

Declaration

public readonly string JournalPluginId

Field Value

Type	Description
string

| Edit this page View Source

LeaseSettings

TBD

Declaration

public readonly LeaseUsageSettings LeaseSettings

Field Value

Type	Description
LeaseUsageSettings

| Edit this page View Source

PassivateIdleEntityAfter

Passivate entities that have not received any message in this interval. Note that only messages sent through sharding are counted, so direct messages to the IActorRef of the actor or messages that it sends to itself are not counted as activity. Use 0 to disable automatic passivation. It is always disabled if RememberEntities is enabled.

Declaration

public readonly TimeSpan PassivateIdleEntityAfter

Field Value

Type	Description
TimeSpan

| Edit this page View Source

RememberEntities

True if active entity actors shall be automatically restarted upon Akka.Cluster.Sharding.Shard restart.i.e. if the Akka.Cluster.Sharding.Shard is started on a different ShardRegion due to rebalance or crash.

Declaration

public readonly bool RememberEntities

Field Value

Type	Description
bool

| Edit this page View Source

RememberEntitiesStore

Declaration

public readonly RememberEntitiesStore RememberEntitiesStore

Field Value

Type	Description
RememberEntitiesStore

| Edit this page View Source

Role

Specifies that this entity type requires cluster nodes with a specific role. If the role is not specified all nodes in the cluster are used.

Declaration

public readonly string Role

Field Value

Type	Description
string

| Edit this page View Source

ShardRegionQueryTimeout

Declaration

public readonly TimeSpan ShardRegionQueryTimeout

Field Value

Type	Description
TimeSpan

| Edit this page View Source

SnapshotPluginId

Absolute path to the snapshot plugin configuration entity that is to be used for the internal persistence of ClusterSharding. If not defined the default snapshot plugin is used.Note that this is not related to persistence used by the entity actors.

Declaration

public readonly string SnapshotPluginId

Field Value

Type	Description
string

| Edit this page View Source

StateStoreMode

Declaration

public readonly StateStoreMode StateStoreMode

Field Value

Type	Description
StateStoreMode

| Edit this page View Source

TuningParameters

Additional tuning parameters, see descriptions in reference.conf

Declaration

public readonly TuningParameters TuningParameters

Field Value

Type	Description
TuningParameters

Methods

| Edit this page View Source

Create(ActorSystem)

Create settings from the default configuration akka.cluster.sharding.

Declaration

public static ClusterShardingSettings Create(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

Create(Config, Config)

TBD

Declaration

public static ClusterShardingSettings Create(Config config, Config singletonConfig)

Parameters

Type	Name	Description
Config	config	TBD
Config	singletonConfig	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

WithCoordinatorSingletonSettings(ClusterSingletonManagerSettings)

TBD

Declaration

public ClusterShardingSettings WithCoordinatorSingletonSettings(ClusterSingletonManagerSettings coordinatorSingletonSettings)

Parameters

Type	Name	Description
ClusterSingletonManagerSettings	coordinatorSingletonSettings	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown when the specified `coordinatorSingletonSettings` is undefined.

| Edit this page View Source

WithJournalPluginId(string)

TBD

Declaration

public ClusterShardingSettings WithJournalPluginId(string journalPluginId)

Parameters

Type	Name	Description
string	journalPluginId	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

WithLeaseSettings(LeaseUsageSettings)

Declaration

public ClusterShardingSettings WithLeaseSettings(LeaseUsageSettings leaseSettings)

Parameters

Type	Name	Description
LeaseUsageSettings	leaseSettings

Returns

Type	Description
ClusterShardingSettings

| Edit this page View Source

WithPassivateIdleAfter(TimeSpan)

Declaration

public ClusterShardingSettings WithPassivateIdleAfter(TimeSpan duration)

Parameters

Type	Name	Description
TimeSpan	duration

Returns

Type	Description
ClusterShardingSettings

| Edit this page View Source

WithRememberEntities(bool)

TBD

Declaration

public ClusterShardingSettings WithRememberEntities(bool rememberEntities)

Parameters

Type	Name	Description
bool	rememberEntities	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

WithRole(string)

TBD

Declaration

public ClusterShardingSettings WithRole(string role)

Parameters

Type	Name	Description
string	role	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

WithSnapshotPluginId(string)

TBD

Declaration

public ClusterShardingSettings WithSnapshotPluginId(string snapshotPluginId)

Parameters

Type	Name	Description
string	snapshotPluginId	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

| Edit this page View Source

WithStateStoreMode(StateStoreMode)

Declaration

public ClusterShardingSettings WithStateStoreMode(StateStoreMode mode)

Parameters

Type	Name	Description
StateStoreMode	mode

Returns

Type	Description
ClusterShardingSettings

| Edit this page View Source

WithTuningParameters(TuningParameters)

TBD

Declaration

public ClusterShardingSettings WithTuningParameters(TuningParameters tuningParameters)

Parameters

Type	Name	Description
TuningParameters	tuningParameters	TBD

Returns

Type	Description
ClusterShardingSettings	TBD

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown when the specified `tuningParameters` is undefined.

Implements

INoSerializationVerificationNeeded

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)