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

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. 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 DDataShardCoordinator to any2stringadd[DDataShardCoordinator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DDataShardCoordinator, B)
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to ArrowAssoc[DDataShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val AllShardsKey: GSetKey[String]
  7. val CoordinatorStateKey: LWWRegisterKey[State]
  8. def activate(): Unit
  9. def active: Receive
  10. var aliveRegions: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  11. val allKeys: Set[Key[ReplicatedData]]
  12. var allRegionsRegistered: Boolean
    Definition Classes
    ShardCoordinator
  13. def allocateShardHomesForRememberEntities(): Unit
    Definition Classes
    ShardCoordinator
  14. 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()
  15. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
    Annotations
    @InternalApi()
  16. 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
    Actor
    Annotations
    @InternalApi()
  17. 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()
  18. 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
    Actor
    Annotations
    @InternalApi()
  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  21. val cluster: Cluster
    Definition Classes
    ShardCoordinator
  22. 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
  23. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  24. def continueRebalance(shards: Set[ShardId]): Unit
    Definition Classes
    ShardCoordinator
  25. def ensuring(cond: (DDataShardCoordinator) ⇒ Boolean, msg: ⇒ Any): DDataShardCoordinator
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to Ensuring[DDataShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: (DDataShardCoordinator) ⇒ Boolean): DDataShardCoordinator
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to Ensuring[DDataShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: Boolean, msg: ⇒ Any): DDataShardCoordinator
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to Ensuring[DDataShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean): DDataShardCoordinator
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to Ensuring[DDataShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  31. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to StringFormat[DDataShardCoordinator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  32. def getAllShards(): Unit
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def getCoordinatorState(): Unit
  35. var gracefulShutdownInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  36. 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
  37. def hasAllRegionsRegistered(): Boolean
    Definition Classes
    ShardCoordinator
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. val initEmptyState: State
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def isMember(region: ActorRef): Boolean
    Definition Classes
    ShardCoordinator
  42. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  43. val minMembers: Int
    Definition Classes
    ShardCoordinator
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. implicit val node: Cluster
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. 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] )
  49. 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
    UnrestrictedStashActor
  50. 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
    UnrestrictedStashActor
  51. 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] )
  52. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
    Definition Classes
    ShardCoordinator
  53. val rebalanceTask: Cancellable
    Definition Classes
    ShardCoordinator
  54. 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
    DDataShardCoordinatorActor
  55. def receiveTerminated: Receive
    Definition Classes
    ShardCoordinator
  56. def regionProxyTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  57. def regionTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  58. var regionTerminationInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  59. val removalMargin: FiniteDuration
    Definition Classes
    ShardCoordinator
  60. 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
  61. def sendAllShardsUpdate(newShard: String): Unit
  62. def sendCoordinatorStateUpdate(evt: DomainEvent): Unit
  63. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  64. 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
  65. var shards: Set[String]
  66. def shuttingDown: Receive
    Definition Classes
    ShardCoordinator
  67. 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

  68. var state: State
    Definition Classes
    ShardCoordinator
  69. def stateInitialized(): Unit
    Definition Classes
    ShardCoordinator
  70. 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
  71. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  72. def toString(): String
    Definition Classes
    AnyRef → Any
  73. var unAckedHostShards: Map[ShardId, Cancellable]
    Definition Classes
    ShardCoordinator
  74. 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
  75. 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
  76. def update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit
  77. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  78. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  79. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. def waitingForState(remainingKeys: Set[Key[ReplicatedData]]): Receive
  81. def waitingForStateInitialized: Receive
  82. def waitingForUpdate[E <: DomainEvent](evt: E, afterUpdateCallback: (E) ⇒ Unit, remainingKeys: Set[Key[ReplicatedData]]): Receive
  83. def watchStateActors(): Unit
    Definition Classes
    ShardCoordinator
  84. def [B](y: B): (DDataShardCoordinator, B)
    Implicit
    This member is added by an implicit conversion from DDataShardCoordinator to ArrowAssoc[DDataShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from ShardCoordinator

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DDataShardCoordinator to any2stringadd[DDataShardCoordinator]

Inherited by implicit conversion StringFormat from DDataShardCoordinator to StringFormat[DDataShardCoordinator]

Inherited by implicit conversion Ensuring from DDataShardCoordinator to Ensuring[DDataShardCoordinator]

Inherited by implicit conversion ArrowAssoc from DDataShardCoordinator to ArrowAssoc[DDataShardCoordinator]

Ungrouped