public abstract class AbstractLeastShardAllocationStrategy : IActorSystemDependentAllocationStrategy, IShardAllocationStrategy, INoSerializationVerificationNeeded

Properties

| Edit this page View Source

ClusterState

Declaration

protected virtual ClusterEvent.CurrentClusterState ClusterState { get; }

Property Value

Type	Description
ClusterEvent.CurrentClusterState

| Edit this page View Source

SelfMember

Declaration

protected virtual Member SelfMember { get; }

Property Value

Type	Description
Member

Methods

| Edit this page View Source

AllocateShard(IActorRef, string, IImmutableDictionary<IActorRef, IImmutableList<string>>)

Invoked when the location of a new shard is to be decided.

Declaration

public Task<IActorRef> AllocateShard(IActorRef requester, string shardId, IImmutableDictionary<IActorRef, IImmutableList<string>> currentShardAllocations)

Parameters

Type	Name	Description
IActorRef	requester	Actor reference to the ShardRegion that requested the location of the shard, can be returned if preference should be given to the node where the shard was first accessed.
string	shardId	The id of the shard to allocate.
IImmutableDictionary<IActorRef, IImmutableList<string>>	currentShardAllocations	All actor refs to ShardRegion and their current allocated shards, in the order they were allocated

Returns

Type	Description
Task<IActorRef>	Task of the actor ref of the ShardRegion that is to be responsible for the shard, must be one of the references included in the `currentShardAllocations` parameter.

| Edit this page View Source

IsAGoodTimeToRebalance(IEnumerable<RegionEntry>)

Declaration

protected bool IsAGoodTimeToRebalance(IEnumerable<AbstractLeastShardAllocationStrategy.RegionEntry> regionEntries)

Parameters

Type	Name	Description
IEnumerable<AbstractLeastShardAllocationStrategy.RegionEntry>	regionEntries

Returns

Type	Description
bool

| Edit this page View Source

MostSuitableRegion(IEnumerable<RegionEntry>)

Declaration

protected (IActorRef Region, IImmutableList<string> Shards) MostSuitableRegion(IEnumerable<AbstractLeastShardAllocationStrategy.RegionEntry> regionEntries)

Parameters

Type	Name	Description
IEnumerable<AbstractLeastShardAllocationStrategy.RegionEntry>	regionEntries

Returns

Type	Description
(IActorRef Region, IImmutableList<string> Shards)

| Edit this page View Source

Rebalance(IImmutableDictionary<IActorRef, IImmutableList<string>>, IImmutableSet<string>)

Invoked periodically to decide which shards to rebalance to another location.

Declaration

public abstract Task<IImmutableSet<string>> Rebalance(IImmutableDictionary<IActorRef, IImmutableList<string>> currentShardAllocations, IImmutableSet<string> rebalanceInProgress)

Parameters

Type	Name	Description
IImmutableDictionary<IActorRef, IImmutableList<string>>	currentShardAllocations	All actor refs to ShardRegion and their current allocated shards, in the order they were allocated.
IImmutableSet<string>	rebalanceInProgress	Set of shards that are currently being rebalanced, i.e. you should not include these in the returned set.

Returns

Type	Description
Task<IImmutableSet<string>>	Task of the shards to be migrated, may be empty to skip rebalance in this round.

| Edit this page View Source

RegionEntriesFor(IImmutableDictionary<IActorRef, IImmutableList<string>>)

Declaration

protected ImmutableList<AbstractLeastShardAllocationStrategy.RegionEntry> RegionEntriesFor(IImmutableDictionary<IActorRef, IImmutableList<string>> currentShardAllocations)

Parameters

Type	Name	Description
IImmutableDictionary<IActorRef, IImmutableList<string>>	currentShardAllocations

Returns

Type	Description
ImmutableList<AbstractLeastShardAllocationStrategy.RegionEntry>

| Edit this page View Source

Start(ActorSystem)

Called before any calls to allocate/rebalance. Do not block. If asynchronous actions are required they can be started here and delay the Futures returned by allocate/rebalance.

Declaration

public void Start(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system

Implements

IActorSystemDependentAllocationStrategy

IShardAllocationStrategy

INoSerializationVerificationNeeded

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)