Class/Object

akka.cluster.sharding

ShardCoordinator

Related Docs: object ShardCoordinator | package sharding

Permalink

abstract class ShardCoordinator extends Actor with ActorLogging

Singleton coordinator that decides where to allocate shards.

Source
ShardCoordinator.scala
See also

ClusterSharding extension

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ShardCoordinator
  2. ActorLogging
  3. Actor
  4. AnyRef
  5. 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 ShardCoordinator(typeName: String, settings: ClusterShardingSettings, allocationStrategy: ShardAllocationStrategy)

    Permalink

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

Abstract Value Members

  1. abstract def receive: actor.Actor.Receive

    Permalink

    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
    Actor
  2. abstract def update[E <: DomainEvent](evt: E)(f: (E) ⇒ Unit): Unit

    Permalink

Concrete 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 ShardCoordinator to any2stringadd[ShardCoordinator] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShardCoordinator, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ShardCoordinator to ArrowAssoc[ShardCoordinator] 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
  7. var aliveRegions: Set[ActorRef]

    Permalink
  8. def allocateShardHomes(): Unit

    Permalink
  9. def aroundPostRestart(reason: Throwable): Unit

    Permalink

    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
  10. def aroundPostStop(): Unit

    Permalink

    Can be overridden to intercept calls to postStop.

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

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

    Permalink

    Can be overridden to intercept calls to preRestart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  12. def aroundPreStart(): Unit

    Permalink

    Can be overridden to intercept calls to preStart.

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

    Attributes
    protected[akka]
    Definition Classes
    Actor
  13. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    Permalink

    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
  14. final def asInstanceOf[T0]: T0

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

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

    Permalink
  17. implicit val context: ActorContext

    Permalink

    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
  18. def continueGetShardHome(shard: ShardId, region: ActorRef, getShardHomeSender: ActorRef): Unit

    Permalink
  19. def continueRebalance(shards: Set[ShardId]): Unit

    Permalink
  20. def ensuring(cond: (ShardCoordinator) ⇒ Boolean, msg: ⇒ Any): ShardCoordinator

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

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

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

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

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

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

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

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

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

    Permalink
  30. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def isInstanceOf[T0]: Boolean

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

    Permalink
  33. def log: LoggingAdapter

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

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

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

    Permalink
    Definition Classes
    AnyRef
  37. def postRestart(reason: Throwable): Unit

    Permalink

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

    Permalink

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    ShardCoordinatorActor
  39. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink

    User overridable callback: By default it disposes of all children and then calls postStop().

    User overridable callback: By default it disposes of all children and then calls postStop().

    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
    Actor
    Annotations
    @throws( classOf[Exception] )
  40. def preStart(): Unit

    Permalink

    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] )
  41. var rebalanceInProgress: Set[ShardId]

    Permalink
  42. val rebalanceTask: Cancellable

    Permalink
  43. def receiveTerminated: Receive

    Permalink
  44. def regionProxyTerminated(ref: ActorRef): Unit

    Permalink
  45. def regionTerminated(ref: ActorRef): Unit

    Permalink
  46. var regionTerminationInProgress: Set[ActorRef]

    Permalink
  47. val removalMargin: FiniteDuration

    Permalink
  48. implicit final val self: ActorRef

    Permalink

    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
  49. def sendHostShardMsg(shard: ShardId, region: ActorRef): Unit

    Permalink
  50. final def sender(): ActorRef

    Permalink

    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
  51. def shuttingDown: Receive

    Permalink
  52. var state: State

    Permalink
  53. def stateInitialized(): Unit

    Permalink
  54. def supervisorStrategy: SupervisorStrategy

    Permalink

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

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

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

    Permalink
  58. def unhandled(message: Any): Unit

    Permalink

    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
  59. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. def watchStateActors(): Unit

    Permalink
  63. def [B](y: B): (ShardCoordinator, B)

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

Inherited from ActorLogging

Inherited from Actor

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped