abstract class ShardCoordinator extends Actor with Timers
Singleton coordinator that decides where to allocate shards.
- Source
- ShardCoordinator.scala
- See also
- Alphabetic
- By Inheritance
- ShardCoordinator
- Timers
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ShardCoordinator(settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy)
Type Members
- type Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Abstract Value Members
- 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
- abstract def typeName: String
- Attributes
- protected
- abstract def unstashOneGetShardHomeRequest(): Unit
- Attributes
- protected
- abstract def update[E <: DomainEvent](evt: E)(f: (E) => Unit): Unit
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 ShardCoordinator toany2stringadd[ShardCoordinator] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def active: Receive
- var aliveRegions: Set[ActorRef]
- var allRegionsRegistered: Boolean
- def allocateShardHomesForRememberEntities(): Unit
- def aroundPostRestart(reason: Throwable): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
postRestart
. CallspostRestart
by default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundPostStop(): Unit
INTERNAL API.
- def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
INTERNAL API.
- def aroundPreStart(): Unit
INTERNAL API.
INTERNAL API.
Can be overridden to intercept calls to
preStart
. CallspreStart
by default.- Attributes
- protected[pekko]
- Definition Classes
- Actor
- Annotations
- @InternalApi()
- def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit
INTERNAL API.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val cluster: Cluster
- 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!
pekko.actor.ActorContext is the Scala API.
getContext
returns a pekko.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
- def continueRebalance(shards: Set[ShardId]): Unit
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- var gracefulShutdownInProgress: Set[ActorRef]
- 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
- def hasAllRegionsRegistered(): Boolean
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isMember(region: ActorRef): Boolean
- val log: MarkerLoggingAdapter
- val minMembers: Int
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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])
- def postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- ShardCoordinator → Actor
- 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])
- 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
- var preparingForShutdown: Boolean
- var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
- var rebalanceWorkers: Set[ActorRef]
- def receiveTerminated: Receive
- def regionProxyTerminated(ref: ActorRef): Unit
- def regionTerminated(ref: ActorRef): Unit
- var regionTerminationInProgress: Set[ActorRef]
- val removalMargin: FiniteDuration
- 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
- def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
- 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 pekko.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
- def shutdownShards(shuttingDownRegion: ActorRef, shards: Set[ShardId]): Unit
- def shuttingDown: Receive
- var state: State
- def stateInitialized(): Unit
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def timers: TimerScheduler
Start and cancel timers via the enclosed
TimerScheduler
.Start and cancel timers via the enclosed
TimerScheduler
.- Definition Classes
- Timers
- def toString(): String
- Definition Classes
- AnyRef → Any
- var unAckedHostShards: Map[ShardId, Cancellable]
- 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 pekko.actor.DeathPactException (in case of an unhandled pekko.actor.Terminated message) or publishes an pekko.actor.UnhandledMessage to the actor's system's pekko.event.EventStream
- Definition Classes
- Actor
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- var waitingForLocalRegionToTerminate: Boolean
- def watchStateActors(): Unit
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.