akka.contrib.pattern

ShardCoordinator

class ShardCoordinator extends PersistentActor with ActorLogging

Singleton coordinator that decides where to allocate shards.

Source
ClusterSharding.scala
See also

ClusterSharding extension

Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ShardCoordinator
  2. ActorLogging
  3. PersistentActor
  4. Eventsourced
  5. ProcessorImpl
  6. Recovery
  7. StashFactory
  8. Stash
  9. RequiresMessageQueue
  10. UnrestrictedStash
  11. StashSupport
  12. Snapshotter
  13. Actor
  14. AnyRef
  15. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ShardCoordinator(handOffTimeout: FiniteDuration, rebalanceInterval: FiniteDuration, snapshotInterval: FiniteDuration, allocationStrategy: ShardAllocationStrategy)

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

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

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  9. def aroundPostStop(): Unit

    INTERNAL API.

    INTERNAL API.

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

    INTERNAL API.

    INTERNAL API.

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

    INTERNAL API.

    INTERNAL API.

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

    INTERNAL API.

    INTERNAL API.

    receive

    current behavior.

    Attributes
    protected[akka]
    Definition Classes
    Eventsourced → RecoveryActor
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. 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
  16. final def defer[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    events

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for each event

    Definition Classes
    Eventsourced
  17. final def defer[A](event: A)(handler: (A) ⇒ Unit): Unit

    Defer the handler execution until all pending handlers have been executed.

    Defer the handler execution until all pending handlers have been executed. Allows to define logic within the actor, which will respect the invocation-order-guarantee in respect to persistAsync calls. That is, if persistAsync was invoked before defer, the corresponding handlers will be invoked in the same order as they were registered in.

    This call will NOT result in event being persisted, please use persist or persistAsync, if the given event should possible to replay.

    If there are no pending persist handler calls, the handler will be called immediatly.

    In the event of persistence failures (indicated by PersistenceFailure messages being sent to the PersistentActor, you can handle these messages, which in turn will enable the deferred handlers to run afterwards. If persistence failure messages are left unhandled, the default behavior is to stop the Actor, thus the handlers will not be run.

    event

    event to be handled in the future, when preceeding persist operations have been processes

    handler

    handler for the given event

    Definition Classes
    Eventsourced
  18. def deleteMessages(toSequenceNr: Long, permanent: Boolean): Unit

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Deletes all persistent messages with sequence numbers less than or equal toSequenceNr. If permanent is set to false, the persistent messages are marked as deleted in the journal, otherwise they permanently deleted from the journal.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
  19. def deleteMessages(toSequenceNr: Long): Unit

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    Permanently deletes all persistent messages with sequence numbers less than or equal toSequenceNr.

    toSequenceNr

    upper sequence number bound of persistent messages to be deleted.

    Definition Classes
    ProcessorImpl
  20. def deleteSnapshot(sequenceNr: Long, timestamp: Long): Unit

    Deletes a snapshot identified by sequenceNr and timestamp.

    Deletes a snapshot identified by sequenceNr and timestamp.

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

    Deletes all snapshots matching criteria.

    Deletes all snapshots matching criteria.

    Definition Classes
    Snapshotter
  22. def ensuring(cond: (ShardCoordinator) ⇒ Boolean, msg: ⇒ Any): ShardCoordinator

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef → Any
  31. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  32. val initialBehavior: Receive

    INTERNAL API.

    INTERNAL API.

    Only here for binary compatibility in 2.3.x.

    Attributes
    protected[akka.persistence]
    Definition Classes
    Eventsourced
  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  34. def lastSequenceNr: Long

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet.

    Highest received sequence number so far or 0L if this actor hasn't received a persistent message yet. Usually equal to the sequence number of currentPersistentMessage (unless a receiver implementation is about to re-order persistent messages using stash() and unstash()).

    Definition Classes
    Recovery
  35. def loadSnapshot(persistenceId: String, criteria: SnapshotSelectionCriteria, toSequenceNr: Long): Unit

    Definition Classes
    Snapshotter
  36. def log: LoggingAdapter

    Definition Classes
    ActorLogging
  37. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  40. final def persist[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persist[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    Eventsourced
  41. final def persist[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event. It is guaranteed that no new commands will be received by a persistent actor between a call to persist and the execution of its handler. This also holds for multiple persist calls per received command. Internally, this is achieved by stashing new commands and unstashing them when the event has been persisted and handled. The stash used for that is an internal stash which doesn't interfere with the inherited user stash.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    Within an event handler, applications usually update persistent actor state using persisted event data, notify listeners and reply to command senders.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in receiveCommand.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    Eventsourced
  42. final def persistAsync[A](events: Seq[A])(handler: (A) ⇒ Unit): Unit

    Asynchronously persists events in specified order.

    Asynchronously persists events in specified order. This is equivalent to calling persistAsync[A](event: A)(handler: A => Unit) multiple times with the same handler, except that events are persisted atomically with this method.

    events

    events to be persisted

    handler

    handler for each persisted events

    Definition Classes
    Eventsourced
  43. final def persistAsync[A](event: A)(handler: (A) ⇒ Unit): Unit

    Asynchronously persists event.

    Asynchronously persists event. On successful persistence, handler is called with the persisted event.

    Unlike persist the persistent actor will continue to receive incomming commands between the call to persist and executing it's handler. This asynchronous, non-stashing, version of of persist should be used when you favor throughput over the "command-2 only processed after command-1 effects' have been applied" guarantee, which is provided by the plain persist method.

    An event handler may close over persistent actor state and modify it. The sender of a persisted event is the sender of the corresponding command. This means that one can reply to a command sender within an event handler.

    If persistence of an event fails, the persistent actor will be stopped. This can be customized by handling PersistenceFailure in receiveCommand.

    event

    event to be persisted

    handler

    handler for each persisted event

    Definition Classes
    Eventsourced
  44. def persistenceId: String

    Id of the persistent entity for which messages should be replayed.

    Id of the persistent entity for which messages should be replayed.

    Definition Classes
    ShardCoordinatorRecovery
  45. var persistentState: ShardCoordinator.Internal.State

  46. 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] )
  47. def postStop(): Unit

    Calls super.postStop then unstashes all messages from the internal stash.

    Calls super.postStop then unstashes all messages from the internal stash.

    Definition Classes
    ShardCoordinator → Eventsourced → UnrestrictedStashActor
  48. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Calls super.preRestart then unstashes all messages from the internal stash.

    Calls super.preRestart then unstashes all messages from the internal stash.

    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
    Eventsourced → ProcessorImpl → UnrestrictedStashActor
  49. def preRestartDefault(reason: Throwable, message: Option[Any]): Unit

    Calls preRestart and then super.preRestart().

    Calls preRestart and then super.preRestart(). If processor implementation classes want to opt out from stopping child actors, they should override this method and call preRestart only.

    Definition Classes
    ProcessorImpl
  50. def preStart(): Unit

    User-overridable callback.

    User-overridable callback. Called when a processor is started. Default implementation sends a Recover() to self.

    Definition Classes
    ProcessorImpl → Actor
    Annotations
    @throws( classOf[Exception] )
  51. var rebalanceInProgress: Set[ShardId]

  52. val rebalanceTask: Cancellable

  53. 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
    PersistentActorActor
  54. def receiveCommand: Receive

    Command handler.

    Command handler. Typically validates commands against current state (and/or by communication with other actors). On successful validation, one or more events are derived from a command and these events are then persisted by calling persist. Commands sent to event sourced persistent actors should not be Persistent messages.

    Definition Classes
    ShardCoordinator → Eventsourced
  55. def receiveRecover: Receive

    Recovery handler that receives persisted events during recovery.

    Recovery handler that receives persisted events during recovery. If a state snapshot has been captured and saved, this handler will receive a SnapshotOffer message followed by events that are younger than the offered snapshot.

    This handler must not have side-effects other than changing persistent actor state i.e. it should not perform actions that may fail, such as interacting with external services, for example.

    If recovery fails, the actor will be stopped. This can be customized by handling RecoveryFailure.

    Definition Classes
    ShardCoordinator → Eventsourced
    See also

    Recover

  56. def recoveryFinished: Boolean

    Returns true if this processor has successfully finished recovery.

    Returns true if this processor has successfully finished recovery.

    Definition Classes
    ProcessorImpl
  57. def recoveryRunning: Boolean

    Returns true if this processor is currently recovering.

    Returns true if this processor is currently recovering.

    Definition Classes
    ProcessorImpl
  58. def saveSnapshot(snapshot: Any): Unit

    Saves a snapshot of this snapshotter's state.

    Saves a snapshot of this snapshotter's state. If saving succeeds, this snapshotter will receive a SaveSnapshotSuccess message, otherwise a SaveSnapshotFailure message.

    Definition Classes
    Snapshotter
  59. 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
  60. 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
  61. def snapshotSequenceNr: Long

    Returns lastSequenceNr.

    Returns lastSequenceNr.

    Definition Classes
    RecoverySnapshotter
  62. val snapshotTask: Cancellable

  63. def snapshotterId: String

    Returns persistenceId.

    Returns persistenceId.

    Definition Classes
    ProcessorImpl → Snapshotter
  64. 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

  65. 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
  66. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  67. def toString(): String

    Definition Classes
    AnyRef → Any
  68. 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
    ProcessorImpl → Actor
  69. 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
    Eventsourced → StashSupport
  70. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  73. def [B](y: B): (ShardCoordinator, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from ShardCoordinator to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (shardCoordinator: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from ShardCoordinator to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (shardCoordinator: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. implicit def currentPersistentMessage: Option[Persistent]

    Returns the current persistent message if there is any.

    Returns the current persistent message if there is any.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) currentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  2. def deleteMessage(sequenceNr: Long, permanent: Boolean): Unit

    Deletes a persistent message identified by sequenceNr.

    Deletes a persistent message identified by sequenceNr. If permanent is set to false, the persistent message is marked as deleted in the journal, otherwise it is permanently deleted from the journal. A deleted message is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    permanent

    if false, the message is marked as deleted, otherwise it is permanently deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

  3. def deleteMessage(sequenceNr: Long): Unit

    Marks a persistent message, identified by sequenceNr, as deleted.

    Marks a persistent message, identified by sequenceNr, as deleted. A message marked as deleted is not replayed during recovery. This method is usually called inside preRestartProcessor when a persistent message caused an exception. Processors that want to re-receive that persistent message during recovery should not call this method.

    sequenceNr

    sequence number of the persistent message to be deleted.

    Definition Classes
    ProcessorImpl
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) deleteMessage(sequenceNr) will be removed. Instead, validate before persist, and use deleteMessages for pruning.

  4. def getCurrentPersistentMessage: Persistent

    Java API: returns the current persistent message or null if there is none.

    Java API: returns the current persistent message or null if there is none.

    Definition Classes
    Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) getCurrentPersistentMessage will be removed, sequence number can be retrieved with lastSequenceNr.

  5. def processorId: String

    Processor id.

    Processor id. Defaults to this processor's path and can be overridden.

    Definition Classes
    ProcessorImpl → Recovery
    Annotations
    @deprecated
    Deprecated

    (Since version 2.3.4) Override persistenceId: String instead. Processor will be removed.

  6. def x: ShardCoordinator

    Implicit information
    This member is added by an implicit conversion from ShardCoordinator to ArrowAssoc[ShardCoordinator] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (shardCoordinator: ArrowAssoc[ShardCoordinator]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  7. def x: ShardCoordinator

    Implicit information
    This member is added by an implicit conversion from ShardCoordinator to Ensuring[ShardCoordinator] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (shardCoordinator: Ensuring[ShardCoordinator]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ActorLogging

Inherited from PersistentActor

Inherited from Eventsourced

Inherited from ProcessorImpl

Inherited from Recovery

Inherited from StashFactory

Inherited from Stash

Inherited from UnrestrictedStash

Inherited from StashSupport

Inherited from Snapshotter

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ShardCoordinator to StringAdd

Inherited by implicit conversion any2stringfmt from ShardCoordinator to StringFormat

Inherited by implicit conversion any2ArrowAssoc from ShardCoordinator to ArrowAssoc[ShardCoordinator]

Inherited by implicit conversion any2Ensuring from ShardCoordinator to Ensuring[ShardCoordinator]

Ungrouped