akka.contrib.pattern.ShardCoordinator

LeastShardAllocationStrategy

Related Doc: package ShardCoordinator

class LeastShardAllocationStrategy extends ShardAllocationStrategy with Serializable

The default implementation of ShardCoordinator.LeastShardAllocationStrategy allocates new shards to the ShardRegion with least number of previously allocated shards. It picks shards for rebalancing handoff from the ShardRegion with most number of previously allocated shards. They will then be allocated to the ShardRegion with least number of previously allocated shards, i.e. new members in the cluster. There is a configurable threshold of how large the difference must be to begin the rebalancing. The number of ongoing rebalancing processes can be limited.

Annotations
@SerialVersionUID()
Source
ClusterSharding.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LeastShardAllocationStrategy
  2. Serializable
  3. Serializable
  4. ShardAllocationStrategy
  5. NoSerializationVerificationNeeded
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LeastShardAllocationStrategy(rebalanceThreshold: Int, maxSimultaneousRebalance: Int)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to any2stringadd[LeastShardAllocationStrategy] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (LeastShardAllocationStrategy, B)

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to ArrowAssoc[LeastShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  6. def allocateShard(requester: ActorRef, shardId: ShardId, currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]]): ActorRef

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

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

    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

    shardId

    the id of the shard to allocate

    currentShardAllocations

    all actor refs to ShardRegion and their current allocated shards, in the order they were allocated

    returns

    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

    Definition Classes
    LeastShardAllocationStrategyShardAllocationStrategy
  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (LeastShardAllocationStrategy) ⇒ Boolean, msg: ⇒ Any): LeastShardAllocationStrategy

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to Ensuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (LeastShardAllocationStrategy) ⇒ Boolean): LeastShardAllocationStrategy

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to Ensuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): LeastShardAllocationStrategy

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to Ensuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): LeastShardAllocationStrategy

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to Ensuring[LeastShardAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to StringFormat[LeastShardAllocationStrategy] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  23. def rebalance(currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]], rebalanceInProgress: Set[ShardId]): Set[ShardId]

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

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

    currentShardAllocations

    all actor refs to ShardRegion and their current allocated shards, in the order they were allocated

    rebalanceInProgress

    set of shards that are currently being rebalanced, i.e. you should not include these in the returned set

    returns

    the shards to be migrated, may be empty to skip rebalance in this round

    Definition Classes
    LeastShardAllocationStrategyShardAllocationStrategy
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (LeastShardAllocationStrategy, B)

    Implicit information
    This member is added by an implicit conversion from LeastShardAllocationStrategy to ArrowAssoc[LeastShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from ShardAllocationStrategy

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from LeastShardAllocationStrategy to any2stringadd[LeastShardAllocationStrategy]

Inherited by implicit conversion StringFormat from LeastShardAllocationStrategy to StringFormat[LeastShardAllocationStrategy]

Inherited by implicit conversion Ensuring from LeastShardAllocationStrategy to Ensuring[LeastShardAllocationStrategy]

Inherited by implicit conversion ArrowAssoc from LeastShardAllocationStrategy to ArrowAssoc[LeastShardAllocationStrategy]

Ungrouped