akka.contrib.pattern.ShardCoordinator

ShardAllocationStrategy

Related Doc: package ShardCoordinator

trait ShardAllocationStrategy extends NoSerializationVerificationNeeded

Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.

Java implementations should extend AbstractShardAllocationStrategy.

Source
ClusterSharding.scala
Linear Supertypes
NoSerializationVerificationNeeded, AnyRef, Any
Known Subclasses
AbstractShardAllocationStrategy, LeastShardAllocationStrategy
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ShardAllocationStrategy
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract 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

  2. abstract 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

Concrete 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 ShardAllocationStrategy to any2stringadd[ShardAllocationStrategy] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ShardAllocationStrategy, B)

    Implicit information
    This member is added by an implicit conversion from ShardAllocationStrategy to ArrowAssoc[ShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (ShardAllocationStrategy) ⇒ Boolean, msg: ⇒ Any): ShardAllocationStrategy

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

  9. def ensuring(cond: (ShardAllocationStrategy) ⇒ Boolean): ShardAllocationStrategy

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

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ShardAllocationStrategy

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

  11. def ensuring(cond: Boolean): ShardAllocationStrategy

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

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from ShardAllocationStrategy to StringFormat[ShardAllocationStrategy] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  23. def toString(): String

    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. def →[B](y: B): (ShardAllocationStrategy, B)

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

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped