c

org.apache.pekko.cluster.sharding

PersistentShardCoordinator

class PersistentShardCoordinator extends ShardCoordinator with PersistentActor

Singleton coordinator that decides where to allocate shards.

Users can migrate to using DData to store state then either Event Sourcing or ddata to store the remembered entities.

Annotations
@deprecated
Deprecated

(Since version Akka 2.6.0) Use ddata mode, persistence mode is deprecated.

See also

ClusterSharding extension

Linear Supertypes
PersistentActor, Eventsourced, PersistenceRecovery, PersistenceIdentity, PersistenceStash, StashFactory, Stash, RequiresMessageQueue[DequeBasedMessageQueueSemantics], UnrestrictedStash, StashSupport, Snapshotter, ShardCoordinator, Timers, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PersistentShardCoordinator
  2. PersistentActor
  3. Eventsourced
  4. PersistenceRecovery
  5. PersistenceIdentity
  6. PersistenceStash
  7. StashFactory
  8. Stash
  9. RequiresMessageQueue
  10. UnrestrictedStash
  11. StashSupport
  12. Snapshotter
  13. ShardCoordinator
  14. Timers
  15. Actor
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PersistentShardCoordinator(typeName: String, settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy)

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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def active: Receive
    Definition Classes
    ShardCoordinator
  5. var aliveRegions: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  6. var allRegionsRegistered: Boolean
    Definition Classes
    ShardCoordinator
  7. def allocateShardHomesForRememberEntities(): Unit
    Definition Classes
    ShardCoordinator
  8. def aroundPostRestart(reason: Throwable): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Eventsourced → Actor
  9. def aroundPostStop(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Eventsourced → Actor
  10. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Eventsourced → Actor
  11. def aroundPreStart(): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Eventsourced → Actor
  12. def aroundReceive(receive: Receive, message: Any): Unit
    Attributes
    protected[pekko]
    Definition Classes
    Eventsourced → Actor
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  15. val cluster: Cluster
    Definition Classes
    ShardCoordinator
  16. implicit val context: ActorContext
    Definition Classes
    Actor
  17. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  18. def continueRebalance(shards: Set[ShardId]): Unit
    Definition Classes
    ShardCoordinator
  19. def defer[A](event: A)(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  20. def deferAsync[A](event: A)(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  21. def deleteMessages(toSequenceNr: Long): Unit
    Definition Classes
    Eventsourced
  22. def deleteSnapshot(sequenceNr: Long): Unit
    Definition Classes
    Snapshotter
  23. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit
    Definition Classes
    Snapshotter
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. var gracefulShutdownInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  28. 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
  29. def hasAllRegionsRegistered(): Boolean
    Definition Classes
    ShardCoordinator
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. def internalStashOverflowStrategy: StashOverflowStrategy
    Definition Classes
    PersistenceStash
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isMember(region: ActorRef): Boolean
    Definition Classes
    ShardCoordinator
  34. def journalPluginId: String
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  35. def lastSequenceNr: Long
    Definition Classes
    Eventsourced
  36. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit
    Definition Classes
    Snapshotter
  37. val log: MarkerLoggingAdapter
    Definition Classes
    ShardCoordinator
  38. val minMembers: Int
    Definition Classes
    ShardCoordinator
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  42. def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit
    Attributes
    protected
    Definition Classes
    Eventsourced
    Annotations
    @InternalStableApi()
  43. def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit
    Attributes
    protected
    Definition Classes
    Eventsourced
    Annotations
    @InternalStableApi()
  44. def onRecoveryFailure(cause: Throwable, event: Option[Any]): Unit
    Attributes
    protected
    Definition Classes
    Eventsourced
  45. def persist[A](event: A)(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  46. def persistAll[A](events: Seq[A])(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  47. def persistAllAsync[A](events: Seq[A])(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  48. def persistAsync[A](event: A)(handler: (A) => Unit): Unit
    Definition Classes
    PersistentActor
  49. def persistenceId: String
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  50. def postRestart(reason: Throwable): Unit
    Definition Classes
    Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  51. def postStop(): Unit
    Definition Classes
    UnrestrictedStash → Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  52. def preRestart(reason: Throwable, message: Option[Any]): Unit
    Definition Classes
    UnrestrictedStash → Actor
    Annotations
    @throws(classOf[java.lang.Exception])
  53. def preStart(): Unit
    Definition Classes
    ShardCoordinator → Actor
  54. var preparingForShutdown: Boolean
    Definition Classes
    ShardCoordinator
  55. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]
    Definition Classes
    ShardCoordinator
  56. var rebalanceWorkers: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  57. def receive: Receive
    Definition Classes
    PersistentActor → Actor
  58. def receiveCommand: Receive
    Definition Classes
    PersistentShardCoordinator → Eventsourced
  59. def receiveRecover: Receive
    Definition Classes
    PersistentShardCoordinator → Eventsourced
  60. def receiveSnapshotResult: Receive
  61. def receiveTerminated: Receive
    Definition Classes
    ShardCoordinator
  62. def recovery: Recovery
    Definition Classes
    PersistenceRecovery
  63. def recoveryFinished: Boolean
    Definition Classes
    Eventsourced
  64. def recoveryRunning: Boolean
    Definition Classes
    Eventsourced
  65. def regionProxyTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  66. def regionTerminated(ref: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  67. var regionTerminationInProgress: Set[ActorRef]
    Definition Classes
    ShardCoordinator
  68. val removalMargin: FiniteDuration
    Definition Classes
    ShardCoordinator
  69. def saveSnapshot(snapshot: Any): Unit
    Definition Classes
    Snapshotter
  70. def saveSnapshotWhenNeeded(): Unit
  71. implicit final val self: ActorRef
    Definition Classes
    Actor
  72. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit
    Definition Classes
    ShardCoordinator
  73. final def sender(): ActorRef
    Definition Classes
    Actor
  74. def shutdownShards(shuttingDownRegion: ActorRef, shards: Set[ShardId]): Unit
    Definition Classes
    ShardCoordinator
  75. def shuttingDown: Receive
    Definition Classes
    ShardCoordinator
  76. def snapshotPluginId: String
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  77. def snapshotSequenceNr: Long
    Definition Classes
    Eventsourced → Snapshotter
  78. def snapshotterId: String
    Definition Classes
    Eventsourced → Snapshotter
  79. def stash(): Unit
    Definition Classes
    Eventsourced → StashSupport
  80. var state: State
    Definition Classes
    ShardCoordinator
  81. def stateInitialized(): Unit
    Definition Classes
    ShardCoordinator
  82. def supervisorStrategy: SupervisorStrategy
    Definition Classes
    Actor
  83. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  84. final def timers: TimerScheduler
    Definition Classes
    Timers
  85. def toString(): String
    Definition Classes
    AnyRef → Any
  86. val typeName: String
    Definition Classes
    PersistentShardCoordinator → ShardCoordinator
  87. var unAckedHostShards: Map[ShardId, Cancellable]
    Definition Classes
    ShardCoordinator
  88. def unhandled(message: Any): Unit
    Definition Classes
    Eventsourced → Actor
  89. def unstashAll(): Unit
    Definition Classes
    Eventsourced → StashSupport
  90. def unstashOneGetShardHomeRequest(): Unit
    Attributes
    protected
    Definition Classes
    PersistentShardCoordinator → ShardCoordinator
  91. def update[E <: DomainEvent](evt: E)(f: (E) => Unit): Unit
    Definition Classes
    PersistentShardCoordinator → ShardCoordinator
  92. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  93. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  94. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  95. var waitingForLocalRegionToTerminate: Boolean
    Definition Classes
    ShardCoordinator
  96. def waitingForStateInitialized: Receive
  97. def watchStateActors(): Unit
    Definition Classes
    ShardCoordinator

Deprecated Value Members

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

    (Since version 9)

Inherited from PersistentActor

Inherited from Eventsourced

Inherited from PersistenceRecovery

Inherited from PersistenceIdentity

Inherited from PersistenceStash

Inherited from StashFactory

Inherited from Stash

Inherited from RequiresMessageQueue[DequeBasedMessageQueueSemantics]

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from ShardCoordinator

Inherited from Timers

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped