Packages

t

akka.cluster.sharding.ShardCoordinator

StartableAllocationStrategy

trait StartableAllocationStrategy extends ShardAllocationStrategy

Shard allocation strategy where start is called by the shard coordinator before any calls to rebalance or allocate shard. This can be used if there is any expensive initialization to be done that you do not want to to in the constructor as it will happen on every node rather than just the node that hosts the ShardCoordinator

Source
ShardCoordinator.scala
Linear Supertypes
ShardAllocationStrategy, NoSerializationVerificationNeeded, AnyRef, Any
Known Subclasses
ExternalShardAllocationStrategy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StartableAllocationStrategy
  2. ShardAllocationStrategy
  3. NoSerializationVerificationNeeded
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def allocateShard(requester: ActorRef, shardId: ShardId, currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]]): Future[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

    a Future 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

    Definition Classes
    ShardAllocationStrategy
  2. abstract def rebalance(currentShardAllocations: Map[ActorRef, IndexedSeq[ShardId]], rebalanceInProgress: Set[ShardId]): Future[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

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

    Definition Classes
    ShardAllocationStrategy
  3. abstract def start(): Unit

    Called before any calls to allocate/rebalance.

    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.

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
    This member is added by an implicit conversion from StartableAllocationStrategy to any2stringadd[StartableAllocationStrategy] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StartableAllocationStrategy, B)
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to ArrowAssoc[StartableAllocationStrategy] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (StartableAllocationStrategy) ⇒ Boolean, msg: ⇒ Any): StartableAllocationStrategy
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to Ensuring[StartableAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (StartableAllocationStrategy) ⇒ Boolean): StartableAllocationStrategy
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to Ensuring[StartableAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): StartableAllocationStrategy
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to Ensuring[StartableAllocationStrategy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): StartableAllocationStrategy
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to Ensuring[StartableAllocationStrategy] 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 formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to StringFormat[StartableAllocationStrategy] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def →[B](y: B): (StartableAllocationStrategy, B)
    Implicit
    This member is added by an implicit conversion from StartableAllocationStrategy to ArrowAssoc[StartableAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from ShardAllocationStrategy

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped