Class TuningParameters

TBD

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

Constructors

| Edit this page View Source

TuningParameters(TimeSpan, TimeSpan, int, TimeSpan, TimeSpan, TimeSpan, TimeSpan, TimeSpan, int, int, int, int, TimeSpan, TimeSpan, string, TimeSpan, int, int, int, int, double)

TBD

Declaration
public TuningParameters(TimeSpan coordinatorFailureBackoff, TimeSpan retryInterval, int bufferSize, TimeSpan handOffTimeout, TimeSpan shardStartTimeout, TimeSpan shardFailureBackoff, TimeSpan entityRestartBackoff, TimeSpan rebalanceInterval, int snapshotAfter, int keepNrOfBatches, int leastShardAllocationRebalanceThreshold, int leastShardAllocationMaxSimultaneousRebalance, TimeSpan waitingForStateTimeout, TimeSpan updatingStateTimeout, string entityRecoveryStrategy, TimeSpan entityRecoveryConstantRateStrategyFrequency, int entityRecoveryConstantRateStrategyNumberOfEntities, int coordinatorStateWriteMajorityPlus, int coordinatorStateReadMajorityPlus, int leastShardAllocationAbsoluteLimit, double leastShardAllocationRelativeLimit)
Parameters
Type Name Description
TimeSpan coordinatorFailureBackoff

TBD
TimeSpan retryInterval

TBD
int bufferSize

TBD
TimeSpan handOffTimeout

TBD
TimeSpan shardStartTimeout

TBD
TimeSpan shardFailureBackoff

TBD
TimeSpan entityRestartBackoff

TBD
TimeSpan rebalanceInterval

TBD
int snapshotAfter

TBD
int keepNrOfBatches

Keep this number of old persistent batches
int leastShardAllocationRebalanceThreshold

TBD
int leastShardAllocationMaxSimultaneousRebalance

TBD
TimeSpan waitingForStateTimeout

TBD
TimeSpan updatingStateTimeout

TBD
string entityRecoveryStrategy

TBD
TimeSpan entityRecoveryConstantRateStrategyFrequency

TBD
int entityRecoveryConstantRateStrategyNumberOfEntities

TBD
int coordinatorStateWriteMajorityPlus

TBD
int coordinatorStateReadMajorityPlus

TBD
int leastShardAllocationAbsoluteLimit

TBD
double leastShardAllocationRelativeLimit

TBD
Exceptions
Type Condition
ArgumentException

This exception is thrown when the specified entityRecoveryStrategy is invalid. Acceptable values include: all | constant

Fields

| Edit this page View Source

BufferSize

TBD

Declaration
public readonly int BufferSize
Field Value
Type Description
int
| Edit this page View Source

CoordinatorFailureBackoff

TBD

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

CoordinatorStateReadMajorityPlus

Declaration
public readonly int CoordinatorStateReadMajorityPlus
Field Value
Type Description
int
| Edit this page View Source

CoordinatorStateWriteMajorityPlus

Declaration
public readonly int CoordinatorStateWriteMajorityPlus
Field Value
Type Description
int
| Edit this page View Source

EntityRecoveryConstantRateStrategyFrequency

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

EntityRecoveryConstantRateStrategyNumberOfEntities

Declaration
public readonly int EntityRecoveryConstantRateStrategyNumberOfEntities
Field Value
Type Description
int
| Edit this page View Source

EntityRecoveryStrategy

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

EntityRestartBackoff

TBD

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

HandOffTimeout

TBD

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

KeepNrOfBatches

The shard deletes persistent events (messages and snapshots) after doing snapshot keeping this number of old persistent batches. Batch is of size SnapshotAfter. When set to 0 after snapshot is successfully done all messages with equal or lower sequence number will be deleted. Default value of 2 leaves last maximum 2*SnapshotAfter messages and 3 snapshots (2 old ones + fresh snapshot)

Declaration
public readonly int KeepNrOfBatches
Field Value
Type Description
int
| Edit this page View Source

LeastShardAllocationAbsoluteLimit

Declaration
public readonly int LeastShardAllocationAbsoluteLimit
Field Value
Type Description
int
| Edit this page View Source

LeastShardAllocationMaxSimultaneousRebalance

TBD

Declaration
public readonly int LeastShardAllocationMaxSimultaneousRebalance
Field Value
Type Description
int
| Edit this page View Source

LeastShardAllocationRebalanceThreshold

TBD

Declaration
public readonly int LeastShardAllocationRebalanceThreshold
Field Value
Type Description
int
| Edit this page View Source

LeastShardAllocationRelativeLimit

Declaration
public readonly double LeastShardAllocationRelativeLimit
Field Value
Type Description
double
| Edit this page View Source

RebalanceInterval

TBD

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

RetryInterval

TBD

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

ShardFailureBackoff

TBD

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

ShardStartTimeout

TBD

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

SnapshotAfter

TBD

Declaration
public readonly int SnapshotAfter
Field Value
Type Description
int
| Edit this page View Source

UpdatingStateTimeout

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

WaitingForStateTimeout

Declaration
public readonly TimeSpan WaitingForStateTimeout
Field Value
Type Description
TimeSpan

Methods

| Edit this page View Source

WithBufferSize(int)

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

WithCoordinatorFailureBackoff(TimeSpan)

Declaration
public TuningParameters WithCoordinatorFailureBackoff(TimeSpan coordinatorFailureBackoff)
Parameters
Type Name Description
TimeSpan coordinatorFailureBackoff
Returns
Type Description
TuningParameters
| Edit this page View Source

WithCoordinatorStateReadMajorityPlus(int)

Declaration
public TuningParameters WithCoordinatorStateReadMajorityPlus(int coordinatorStateReadMajorityPlus)
Parameters
Type Name Description
int coordinatorStateReadMajorityPlus
Returns
Type Description
TuningParameters
| Edit this page View Source

WithCoordinatorStateWriteMajorityPlus(int)

Declaration
public TuningParameters WithCoordinatorStateWriteMajorityPlus(int coordinatorStateWriteMajorityPlus)
Parameters
Type Name Description
int coordinatorStateWriteMajorityPlus
Returns
Type Description
TuningParameters
| Edit this page View Source

WithEntityRecoveryConstantRateStrategyFrequency(TimeSpan)

Declaration
public TuningParameters WithEntityRecoveryConstantRateStrategyFrequency(TimeSpan entityRecoveryConstantRateStrategyFrequency)
Parameters
Type Name Description
TimeSpan entityRecoveryConstantRateStrategyFrequency
Returns
Type Description
TuningParameters
| Edit this page View Source

WithEntityRecoveryConstantRateStrategyNumberOfEntities(int)

Declaration
public TuningParameters WithEntityRecoveryConstantRateStrategyNumberOfEntities(int entityRecoveryConstantRateStrategyNumberOfEntities)
Parameters
Type Name Description
int entityRecoveryConstantRateStrategyNumberOfEntities
Returns
Type Description
TuningParameters
| Edit this page View Source

WithEntityRecoveryStrategy(string)

Declaration
public TuningParameters WithEntityRecoveryStrategy(string entityRecoveryStrategy)
Parameters
Type Name Description
string entityRecoveryStrategy
Returns
Type Description
TuningParameters
| Edit this page View Source

WithEntityRestartBackoff(TimeSpan)

Declaration
public TuningParameters WithEntityRestartBackoff(TimeSpan entityRestartBackoff)
Parameters
Type Name Description
TimeSpan entityRestartBackoff
Returns
Type Description
TuningParameters
| Edit this page View Source

WithHandOffTimeout(TimeSpan)

Declaration
public TuningParameters WithHandOffTimeout(TimeSpan handOffTimeout)
Parameters
Type Name Description
TimeSpan handOffTimeout
Returns
Type Description
TuningParameters
| Edit this page View Source

WithKeepNrOfBatches(int)

Declaration
public TuningParameters WithKeepNrOfBatches(int keepNrOfBatches)
Parameters
Type Name Description
int keepNrOfBatches
Returns
Type Description
TuningParameters
| Edit this page View Source

WithLeastShardAllocationAbsoluteLimit(int)

Declaration
public TuningParameters WithLeastShardAllocationAbsoluteLimit(int leastShardAllocationAbsoluteLimit)
Parameters
Type Name Description
int leastShardAllocationAbsoluteLimit
Returns
Type Description
TuningParameters
| Edit this page View Source

WithLeastShardAllocationMaxSimultaneousRebalance(int)

Declaration
public TuningParameters WithLeastShardAllocationMaxSimultaneousRebalance(int leastShardAllocationMaxSimultaneousRebalance)
Parameters
Type Name Description
int leastShardAllocationMaxSimultaneousRebalance
Returns
Type Description
TuningParameters
| Edit this page View Source

WithLeastShardAllocationRebalanceThreshold(int)

Declaration
public TuningParameters WithLeastShardAllocationRebalanceThreshold(int leastShardAllocationRebalanceThreshold)
Parameters
Type Name Description
int leastShardAllocationRebalanceThreshold
Returns
Type Description
TuningParameters
| Edit this page View Source

WithLeastShardAllocationRelativeLimit(double)

Declaration
public TuningParameters WithLeastShardAllocationRelativeLimit(double leastShardAllocationRelativeLimit)
Parameters
Type Name Description
double leastShardAllocationRelativeLimit
Returns
Type Description
TuningParameters
| Edit this page View Source

WithRebalanceInterval(TimeSpan)

Declaration
public TuningParameters WithRebalanceInterval(TimeSpan rebalanceInterval)
Parameters
Type Name Description
TimeSpan rebalanceInterval
Returns
Type Description
TuningParameters
| Edit this page View Source

WithRetryInterval(TimeSpan)

Declaration
public TuningParameters WithRetryInterval(TimeSpan retryInterval)
Parameters
Type Name Description
TimeSpan retryInterval
Returns
Type Description
TuningParameters
| Edit this page View Source

WithShardFailureBackoff(TimeSpan)

Declaration
public TuningParameters WithShardFailureBackoff(TimeSpan shardFailureBackoff)
Parameters
Type Name Description
TimeSpan shardFailureBackoff
Returns
Type Description
TuningParameters
| Edit this page View Source

WithShardStartTimeout(TimeSpan)

Declaration
public TuningParameters WithShardStartTimeout(TimeSpan shardStartTimeout)
Parameters
Type Name Description
TimeSpan shardStartTimeout
Returns
Type Description
TuningParameters
| Edit this page View Source

WithSnapshotAfter(int)

Declaration
public TuningParameters WithSnapshotAfter(int snapshotAfter)
Parameters
Type Name Description
int snapshotAfter
Returns
Type Description
TuningParameters
| Edit this page View Source

WithUpdatingStateTimeout(TimeSpan)

Declaration
public TuningParameters WithUpdatingStateTimeout(TimeSpan updatingStateTimeout)
Parameters
Type Name Description
TimeSpan updatingStateTimeout
Returns
Type Description
TuningParameters
| Edit this page View Source

WithWaitingForStateTimeout(TimeSpan)

Declaration
public TuningParameters WithWaitingForStateTimeout(TimeSpan waitingForStateTimeout)
Parameters
Type Name Description
TimeSpan waitingForStateTimeout
Returns
Type Description
TuningParameters

Extension Methods