trait ShardAllocationStrategy extends NoSerializationVerificationNeeded
Interface of the pluggable shard allocation and rebalancing logic used by the ShardCoordinator.
Java implementations should extend AbstractShardAllocationStrategy.
- Source
- ShardCoordinator.scala
- Alphabetic
- By Inheritance
- ShardAllocationStrategy
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
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
ShardRegionand their current allocated shards, in the order they were allocated- returns
a
Futureof the actor ref of the ShardRegion that is to be responsible for the shard, must be one of the references included in thecurrentShardAllocationsparameter
-
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
ShardRegionand 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
Futureof the shards to be migrated, may be empty to skip rebalance in this round
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to any2stringadd[ShardAllocationStrategy] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (ShardAllocationStrategy, B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
ensuring(cond: (ShardAllocationStrategy) ⇒ Boolean, msg: ⇒ Any): ShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to Ensuring[ShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (ShardAllocationStrategy) ⇒ Boolean): ShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to Ensuring[ShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): ShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to Ensuring[ShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): ShardAllocationStrategy
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to Ensuring[ShardAllocationStrategy] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- 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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
→[B](y: B): (ShardAllocationStrategy, B)
- Implicit
- This member is added by an implicit conversion from ShardAllocationStrategy to ArrowAssoc[ShardAllocationStrategy] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc