c

akka.cluster.sharding

DDataShardCoordinator

class DDataShardCoordinator extends ShardCoordinator with Stash

Singleton coordinator (with state based on ddata) that decides where to allocate shards.

Source
ShardCoordinator.scala
See also

ClusterSharding extension

Linear Supertypes
Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, ShardCoordinator, ActorLogging, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DDataShardCoordinator
  2. Stash
  3. RequiresMessageQueue
  4. UnrestrictedStash
  5. StashSupport
  6. ShardCoordinator
  7. ActorLogging
  8. Actor
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DDataShardCoordinator(typeName: String, settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy, replicator: ActorRef, majorityMinCap: Int, rememberEntities: Boolean)

Type Members

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

Value Members

  1. val AllShardsKey: GSetKey[String]
  2. val CoordinatorStateKey: LWWRegisterKey[State]
  3. def activate(): Unit
  4. def active: Receive
    Definition Classes
    DDataShardCoordinator → ShardCoordinator
  5. var aliveRegions: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  6. val allKeys: Set[Key[ReplicatedData]]
  7. var allRegionsRegistered: Boolean
    Definition Classes
    ShardCoordinator
  8. def allocateShardHomesForRememberEntities(): Unit
    Definition Classes
    ShardCoordinator
  9. val cluster: Cluster
    Definition Classes
    ShardCoordinator
  10. 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
  11. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  12. def continueRebalance(shards: Set[ShardId]): Unit
    Definition Classes
    ShardCoordinator
  13. def getAllShards(): Unit
  14. def getCoordinatorState(): Unit
  15. var gracefulShutdownInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  16. 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

    Definition Classes
    ShardCoordinator
  17. def hasAllRegionsRegistered(): Boolean
    Definition Classes
    ShardCoordinator
  18. val initEmptyState: State
  19. def isMember(region: ActorRef): Boolean
    Definition Classes
    ShardCoordinator
  20. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  21. val minMembers: Int
    Definition Classes
    ShardCoordinator
  22. implicit val node: Cluster
  23. 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] )
  24. def postStop(): Unit

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox and clears the stash. Must be called when overriding this method, otherwise stashed messages won't be propagated to DeadLetters when actor stops.

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

    Overridden callback.

    Overridden callback. Prepends all messages in the stash to the mailbox, clears the stash, stops all children and invokes the postStop() callback.

    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
    UnrestrictedStash → Actor
  26. 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] )
  27. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
    Definition Classes
    ShardCoordinator
  28. val rebalanceTask: Cancellable
    Definition Classes
    ShardCoordinator
  29. def receive: 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
    DDataShardCoordinator → Actor
  30. def receiveTerminated: Receive
    Definition Classes
    ShardCoordinator
  31. def regionProxyTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  32. def regionTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  33. var regionTerminationInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  34. val removalMargin: FiniteDuration
    Definition Classes
    ShardCoordinator
  35. 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
  36. def sendAllShardsUpdate(newShard: String): Unit
  37. def sendCoordinatorStateUpdate(evt: DomainEvent): Unit
  38. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  39. 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
  40. var shards: Set[String]
  41. def shuttingDown: Receive
    Definition Classes
    ShardCoordinator
  42. def stash(): Unit

    Adds the current message (the message that the actor received last) to the actor's stash.

    Adds the current message (the message that the actor received last) to the actor's stash.

    Definition Classes
    StashSupport
    Exceptions thrown

    IllegalStateException if the same message is stashed more than once

    StashOverflowException in case of a stash capacity violation

  43. var state: State
    Definition Classes
    ShardCoordinator
  44. def stateInitialized(): Unit
    Definition Classes
    ShardCoordinator
  45. 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
  46. var unAckedHostShards: Map[ShardId, Cancellable]
    Definition Classes
    ShardCoordinator
  47. 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
  48. def unstashAll(): Unit

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Prepends all messages in the stash to the mailbox, and then clears the stash.

    Messages from the stash are enqueued to the mailbox until the capacity of the mailbox (if any) has been reached. In case a bounded mailbox overflows, a MessageQueueAppendFailedException is thrown.

    The stash is guaranteed to be empty after calling unstashAll().

    Definition Classes
    StashSupport
  49. def update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit
    Definition Classes
    DDataShardCoordinator → ShardCoordinator
  50. def waitingForState(remainingKeys: Set[Key[ReplicatedData]]): Receive
  51. def waitingForStateInitialized: Receive
  52. def waitingForUpdate[E <: DomainEvent](evt: E, afterUpdateCallback: (E) ⇒ Unit, remainingKeys: Set[Key[ReplicatedData]]): Receive
  53. def watchStateActors(): Unit
    Definition Classes
    ShardCoordinator