abstract class ShardCoordinator extends Actor with Timers

Singleton coordinator that decides where to allocate shards.

Source
ShardCoordinator.scala
See also

ClusterSharding extension

Linear Supertypes
Timers, Actor, AnyRef, Any
Known Subclasses
PersistentShardCoordinator
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardCoordinator
  2. Timers
  3. Actor
  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. 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

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.

    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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toany2stringadd[ShardCoordinator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShardCoordinator, B)
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toArrowAssoc[ShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def active: Receive
  7. var aliveRegions: Set[ActorRef]
  8. var allRegionsRegistered: Boolean
  9. def allocateShardHomesForRememberEntities(): Unit
  10. def aroundPostRestart(reason: Throwable): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  11. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[akka]
    Definition Classes
    Timers → Actor
  12. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Timers → Actor
  13. def aroundPreStart(): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  14. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    Timers → Actor
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  17. val cluster: Cluster
  18. implicit val context: ActorContext

    Scala API: Stores the context for this actor, including self, and sender.

    Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as forward.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    akka.actor.ActorContext is the Scala API. getContext returns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  19. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
  20. def continueRebalance(shards: Set[ShardId]): Unit
  21. def ensuring(cond: (ShardCoordinator) => Boolean, msg: => Any): ShardCoordinator
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toEnsuring[ShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (ShardCoordinator) => Boolean): ShardCoordinator
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toEnsuring[ShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: => Any): ShardCoordinator
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toEnsuring[ShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): ShardCoordinator
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toEnsuring[ShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. var gracefulShutdownInProgress: Set[ActorRef]
  29. 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

  30. def hasAllRegionsRegistered(): Boolean
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isMember(region: ActorRef): Boolean
  34. val log: MarkerLoggingAdapter
  35. val minMembers: Int
  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  39. def postRestart(reason: Throwable): Unit

    User overridable callback: By default it calls preStart().

    User overridable callback: By default it calls preStart().

    reason

    the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  40. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    ShardCoordinator → Actor
  41. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    Scala API: User overridable callback: By default it disposes of all children and then calls postStop().

    reason

    the Throwable that caused the restart to happen

    message

    optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.

    Definition Classes
    Actor
    Annotations
    @throws(classOf[Exception])
  42. def preStart(): Unit

    User overridable callback.

    User overridable callback.

    Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

    Definition Classes
    ShardCoordinator → Actor
  43. var preparingForShutdown: Boolean
  44. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
  45. var rebalanceWorkers: Set[ActorRef]
  46. def receiveTerminated: Receive
  47. def regionProxyTerminated(ref: ActorRef): Unit
  48. def regionTerminated(ref: ActorRef): Unit
  49. var regionTerminationInProgress: Set[ActorRef]
  50. val removalMargin: FiniteDuration
  51. implicit final val self: ActorRef

    The 'self' field holds the ActorRef for this actor.

    The 'self' field holds the ActorRef for this actor.

    Can be used to send messages to itself: 

    self ! message

    Definition Classes
    Actor
  52. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
  53. final def sender(): ActorRef

    The reference sender Actor of the last received message.

    The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else deadLetters in akka.actor.ActorSystem.

    WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!

    Definition Classes
    Actor
  54. def shutdownShards(shuttingDownRegion: ActorRef, shards: Set[ShardId]): Unit
  55. def shuttingDown: Receive
  56. var state: State
  57. def stateInitialized(): Unit
  58. def supervisorStrategy: SupervisorStrategy

    User overridable definition the strategy to use for supervising child actors.

    User overridable definition the strategy to use for supervising child actors.

    Definition Classes
    Actor
  59. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  60. final def timers: TimerScheduler

    Start and cancel timers via the enclosed TimerScheduler.

    Start and cancel timers via the enclosed TimerScheduler.

    Definition Classes
    Timers
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. var unAckedHostShards: Map[ShardId, Cancellable]
  63. def unhandled(message: Any): Unit

    User overridable callback.

    User overridable callback.

    Is called when a message isn't handled by the current behavior of the actor by default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream

    Definition Classes
    Actor
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. var waitingForLocalRegionToTerminate: Boolean
  68. var waitingForShardsToStop: Map[ShardId, Set[(ActorRef, UUID)]]
  69. 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)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toStringFormat[ShardCoordinator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (ShardCoordinator, B)
    Implicit
    This member is added by an implicit conversion from ShardCoordinator toArrowAssoc[ShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Timers

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromShardCoordinator to any2stringadd[ShardCoordinator]

Inherited by implicit conversion StringFormat fromShardCoordinator to StringFormat[ShardCoordinator]

Inherited by implicit conversion Ensuring fromShardCoordinator to Ensuring[ShardCoordinator]

Inherited by implicit conversion ArrowAssoc fromShardCoordinator to ArrowAssoc[ShardCoordinator]

Ungrouped