abstract class ShardCoordinator extends Actor with Timers

Singleton coordinator that decides where to allocate shards.

See also

ClusterSharding extension

Linear Supertypes
Timers, Actor, AnyRef, Any
Known Subclasses
PersistentShardCoordinator
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardCoordinator
  2. Timers
  3. Actor
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ShardCoordinator(settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy)

Type Members

  1. type Receive = PartialFunction[Any, Unit]
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def receive: actor.Actor.Receive
    Definition Classes
    Actor
  2. abstract def typeName: String
    Attributes
    protected
  3. abstract def unstashOneGetShardHomeRequest(): Unit
    Attributes
    protected
  4. abstract def update[E <: DomainEvent](evt: E)(f: (E) => Unit): Unit

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def active: Receive
  5. var aliveRegions: Set[ActorRef]
  6. var allRegionsRegistered: Boolean
  7. def allocateShardHomesForRememberEntities(): Unit
  8. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  9. def aroundPostStop(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Timers → Actor
  10. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Timers → Actor
  11. def aroundPreStart(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  12. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Timers → Actor
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  15. val cluster: Cluster
  16. implicit val context: ActorContext
    Definition Classes
    Actor
  17. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
  18. def continueRebalance(shards: Set[ShardId]): Unit
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. var gracefulShutdownInProgress: Set[ActorRef]
  23. def handleGetShardHome(shard: ShardId): Boolean

    returns

    true if the message could be handled without state update, i.e. the shard location was known or the request was deferred or ignored

  24. def hasAllRegionsRegistered(): Boolean
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isMember(region: ActorRef): Boolean
  28. val log: MarkerLoggingAdapter
  29. val minMembers: Int
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  33. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  34. def postStop(): Unit
    Definition Classes
    ShardCoordinator → Actor
  35. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  36. def preStart(): Unit
    Definition Classes
    ShardCoordinator → Actor
  37. var preparingForShutdown: Boolean
  38. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
  39. var rebalanceWorkers: Set[ActorRef]
  40. def receiveTerminated: Receive
  41. def regionProxyTerminated(ref: ActorRef): Unit
  42. def regionTerminated(ref: ActorRef): Unit
  43. var regionTerminationInProgress: Set[ActorRef]
  44. val removalMargin: FiniteDuration
  45. implicit final val self: ActorRef
    Definition Classes
    Actor
  46. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
  47. final def sender(): ActorRef
    Definition Classes
    Actor
  48. def shutdownShards(shuttingDownRegion: ActorRef, shards: Set[ShardId]): Unit
  49. def shuttingDown: Receive
  50. var state: State
  51. def stateInitialized(): Unit
  52. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. final def timers: TimerScheduler
    Definition Classes
    Timers
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. var unAckedHostShards: Map[ShardId, Cancellable]
  57. def unhandled(message: Any): Unit
    Definition Classes
    Actor
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  60. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. var waitingForLocalRegionToTerminate: Boolean
  62. def watchStateActors(): Unit

Deprecated Value Members

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

    (Since version 9)

Inherited from Timers

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped