Class

akka.cluster.sharding

PersistentShardCoordinator

Related Doc: package sharding

Permalink

class PersistentShardCoordinator extends ShardCoordinator with PersistentActor

Singleton coordinator that decides where to allocate shards.

Source
ShardCoordinator.scala
See also

ClusterSharding extension

Linear Supertypes
Type Hierarchy
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. ActorLogging
  15. Actor
  16. AnyRef
  17. 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 PersistentShardCoordinator(typeName: String, settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy)

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to any2stringadd[PersistentShardCoordinator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PersistentShardCoordinator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to ArrowAssoc[PersistentShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def active: Receive

    Permalink
    Definition Classes
    ShardCoordinator
  7. var aliveRegions: Set[ActorRef]

    Permalink
    Definition Classes
    ShardCoordinator
  8. var allRegionsRegistered: Boolean

    Permalink
    Definition Classes
    ShardCoordinator
  9. def allocateShardHomesForRememberEntities(): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  10. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  11. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  12. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  13. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  14. def aroundReceive(receive: Receive, message: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → Actor
  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val cluster: Cluster

    Permalink
    Definition Classes
    ShardCoordinator
  18. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor
  19. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  20. def continueRebalance(shards: Set[ShardId]): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  21. def defer[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  22. def deferAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  23. def deleteMessages(toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Eventsourced
  24. def deleteSnapshot(sequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  25. def deleteSnapshots(criteria: SnapshotSelectionCriteria): Unit

    Permalink
    Definition Classes
    Snapshotter
  26. def ensuring(cond: (PersistentShardCoordinator) ⇒ Boolean, msg: ⇒ Any): PersistentShardCoordinator

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to Ensuring[PersistentShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. def ensuring(cond: (PersistentShardCoordinator) ⇒ Boolean): PersistentShardCoordinator

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to Ensuring[PersistentShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  28. def ensuring(cond: Boolean, msg: ⇒ Any): PersistentShardCoordinator

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to Ensuring[PersistentShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  29. def ensuring(cond: Boolean): PersistentShardCoordinator

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to Ensuring[PersistentShardCoordinator] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  30. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  32. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  33. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to StringFormat[PersistentShardCoordinator] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  34. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  35. var gracefulShutdownInProgress: Set[ActorRef]

    Permalink
    Definition Classes
    ShardCoordinator
  36. def handleGetShardHome(shard: ShardId): Boolean

    Permalink

    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

    Permalink
    Definition Classes
    ShardCoordinator
  38. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  39. def internalStashOverflowStrategy: StashOverflowStrategy

    Permalink
    Definition Classes
    PersistenceStash
  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  41. def isMember(region: ActorRef): Boolean

    Permalink
    Definition Classes
    ShardCoordinator
  42. def journalPluginId: String

    Permalink
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  43. def lastSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced
  44. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Permalink
    Definition Classes
    Snapshotter
  45. def log: LoggingAdapter

    Permalink
    Definition Classes
    ActorLogging
  46. val minMembers: Int

    Permalink
    Definition Classes
    ShardCoordinator
  47. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  48. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  49. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  50. def onPersistFailure(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
    Annotations
    @InternalStableApi()
  51. def onPersistRejected(cause: Throwable, event: Any, seqNr: Long): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
    Annotations
    @InternalStableApi()
  52. def onRecoveryFailure(cause: Throwable, event: Option[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Eventsourced
    Annotations
    @InternalStableApi()
  53. def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
    Annotations
    @InternalStableApi()
  54. def persistAll[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
    Annotations
    @InternalStableApi()
  55. def persistAllAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  56. def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Permalink
    Definition Classes
    PersistentActor
  57. def persistenceId: String

    Permalink
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  58. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  59. def postStop(): Unit

    Permalink
    Definition Classes
    UnrestrictedStash → Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  60. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Definition Classes
    UnrestrictedStash → Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  61. def preStart(): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )
  62. var rebalanceInProgress: Map[ShardId, Set[ActorRef]]

    Permalink
    Definition Classes
    ShardCoordinator
  63. val rebalanceTask: Cancellable

    Permalink
    Definition Classes
    ShardCoordinator
  64. def receive: Receive

    Permalink
    Definition Classes
    PersistentActor → Actor
  65. def receiveCommand: Receive

    Permalink
    Definition Classes
    PersistentShardCoordinator → Eventsourced
  66. def receiveRecover: Receive

    Permalink
    Definition Classes
    PersistentShardCoordinator → Eventsourced
  67. def receiveSnapshotResult: Receive

    Permalink
  68. def receiveTerminated: Receive

    Permalink
    Definition Classes
    ShardCoordinator
  69. def recovery: Recovery

    Permalink
    Definition Classes
    PersistenceRecovery
  70. def recoveryFinished: Boolean

    Permalink
    Definition Classes
    Eventsourced
  71. def recoveryRunning: Boolean

    Permalink
    Definition Classes
    Eventsourced
  72. def regionProxyTerminated(ref: ActorRef): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  73. def regionTerminated(ref: ActorRef): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  74. var regionTerminationInProgress: Set[ActorRef]

    Permalink
    Definition Classes
    ShardCoordinator
  75. val removalMargin: FiniteDuration

    Permalink
    Definition Classes
    ShardCoordinator
  76. def saveSnapshot(snapshot: Any): Unit

    Permalink
    Definition Classes
    Snapshotter
  77. def saveSnapshotWhenNeeded(): Unit

    Permalink
  78. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor
  79. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  80. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor
  81. def shuttingDown: Receive

    Permalink
    Definition Classes
    ShardCoordinator
  82. def snapshotPluginId: String

    Permalink
    Definition Classes
    PersistentShardCoordinator → PersistenceIdentity
  83. def snapshotSequenceNr: Long

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  84. def snapshotterId: String

    Permalink
    Definition Classes
    Eventsourced → Snapshotter
  85. def stash(): Unit

    Permalink
    Definition Classes
    Eventsourced → StashSupport
  86. var state: State

    Permalink
    Definition Classes
    ShardCoordinator
  87. def stateInitialized(): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  88. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    Actor
  89. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  90. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  91. var unAckedHostShards: Map[ShardId, Cancellable]

    Permalink
    Definition Classes
    ShardCoordinator
  92. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Eventsourced → Actor
  93. def unstashAll(): Unit

    Permalink
    Definition Classes
    Eventsourced → StashSupport
  94. def update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit

    Permalink
  95. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  96. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. def waitingForStateInitialized: Receive

    Permalink
  99. def watchStateActors(): Unit

    Permalink
    Definition Classes
    ShardCoordinator
  100. def [B](y: B): (PersistentShardCoordinator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from PersistentShardCoordinator to ArrowAssoc[PersistentShardCoordinator] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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 ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped