abstract class ShardCoordinator extends Actor with ActorLogging
Singleton coordinator that decides where to allocate shards.
- Source
- ShardCoordinator.scala
- See also
- Alphabetic
- By Inheritance
- ShardCoordinator
- ActorLogging
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ShardCoordinator(typeName: String, 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 update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit
Concrete Value Members
- def active: Receive
- var aliveRegions: Set[ActorRef]
- var allRegionsRegistered: Boolean
- def allocateShardHomesForRememberEntities(): Unit
- 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!
akka.actor.ActorContext is the Scala API.
getContextreturns a akka.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
- var gracefulShutdownInProgress: Set[ActorRef]
-
def
handleGetShardHome(shard: ShardId): Boolean
- returns
trueif 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 isMember(region: ActorRef): Boolean
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
- val minMembers: Int
-
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
- Actor
- Annotations
- @throws( classOf[Exception] )
- var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
- val rebalanceTask: Cancellable
- 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
deadLettersin 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
- 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
- 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 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
- def watchStateActors(): Unit