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)

Type Members

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

Value Members

  1. val CoordinatorStateKey: LWWRegisterKey[State]
  2. def activate(): Unit
  3. def active: Receive
    Definition Classes
    ShardCoordinator
  4. var aliveRegions: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  5. var allRegionsRegistered: Boolean
    Definition Classes
    ShardCoordinator
  6. def allocateShardHomesForRememberEntities(): Unit
    Definition Classes
    ShardCoordinator
  7. val cluster: Cluster
    Definition Classes
    ShardCoordinator
  8. implicit val context: ActorContext

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

    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.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  9. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  10. def continueRebalance(shards: Set[ShardId]): Unit
    Definition Classes
    ShardCoordinator
  11. def getState(): Unit
  12. var gracefulShutdownInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  13. def hasAllRegionsRegistered(): Boolean
    Definition Classes
    ShardCoordinator
  14. val initEmptyState: State
  15. def isMember(region: ActorRef): Boolean
    Definition Classes
    ShardCoordinator
  16. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  17. val minMembers: Int
    Definition Classes
    ShardCoordinator
  18. implicit val node: Cluster
  19. 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] )
  20. 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
  21. 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
  22. 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] )
  23. var rebalanceInProgress: Set[ShardId]
    Definition Classes
    ShardCoordinator
  24. val rebalanceTask: Cancellable
    Definition Classes
    ShardCoordinator
  25. def receive: Receive

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

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

    Definition Classes
    DDataShardCoordinator → Actor
  26. def receiveTerminated: Receive
    Definition Classes
    ShardCoordinator
  27. def regionProxyTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  28. def regionTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  29. var regionTerminationInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  30. val removalMargin: FiniteDuration
    Definition Classes
    ShardCoordinator
  31. 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
  32. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  33. def sendUpdate(evt: DomainEvent): Unit
  34. 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
  35. def shuttingDown: Receive
    Definition Classes
    ShardCoordinator
  36. 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

  37. var state: State
    Definition Classes
    ShardCoordinator
  38. def stateInitialized(): Unit
    Definition Classes
    ShardCoordinator
  39. 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
  40. var unAckedHostShards: Map[ShardId, Cancellable]
    Definition Classes
    ShardCoordinator
  41. 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
  42. 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
  43. def update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit
    Definition Classes
    DDataShardCoordinator → ShardCoordinator
  44. val updatingStateTimeout: FiniteDuration
  45. def waitingForState: Receive
  46. def waitingForStateInitialized: Receive
  47. val waitingForStateTimeout: FiniteDuration
  48. def waitingForUpdate[E <: DomainEvent](evt: E, afterUpdateCallback: (DomainEvent) ⇒ Unit): Receive
  49. def watchStateActors(): Unit
    Definition Classes
    ShardCoordinator