class ShardRegion extends Actor with ActorLogging

This actor creates children entity actors on demand for the shards that it is told to be responsible for. It delegates messages targeted to other shards to the responsible ShardRegion actor on other nodes.

Source
ShardRegion.scala
See also

ClusterSharding extension

Linear Supertypes
ActorLogging, Actor, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShardRegion
  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 ShardRegion(typeName: String, entityProps: Option[Props], settings: ClusterShardingSettings, coordinatorPath: String, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId, handOffStopMessage: Any)

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 ShardRegion to any2stringadd[ShardRegion] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ShardRegion, B)
    Implicit
    This member is added by an implicit conversion from ShardRegion to ArrowAssoc[ShardRegion] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val ageOrdering: Ordering[Member]
  7. 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
  8. def aroundPostStop(): Unit

    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
  9. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

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

    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
  11. 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
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def askAllShards[T](msg: Any)(implicit arg0: ClassTag[T]): Future[Seq[(ShardId, T)]]
  14. def bufferMessage(shardId: ShardId, msg: Any, snd: ActorRef): Unit
  15. def changeMembers(newMembers: SortedSet[Member]): Unit
  16. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. val cluster: Cluster
  18. 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
  19. var coordinator: Option[ActorRef]
  20. def coordinatorSelection: Option[ActorSelection]
  21. def deliverBufferedMessages(shardId: ShardId, receiver: ActorRef): Unit
  22. def deliverMessage(msg: Any, snd: ActorRef): Unit
  23. def ensuring(cond: (ShardRegion) ⇒ Boolean, msg: ⇒ Any): ShardRegion
    Implicit
    This member is added by an implicit conversion from ShardRegion to Ensuring[ShardRegion] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: (ShardRegion) ⇒ Boolean): ShardRegion
    Implicit
    This member is added by an implicit conversion from ShardRegion to Ensuring[ShardRegion] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. def ensuring(cond: Boolean, msg: ⇒ Any): ShardRegion
    Implicit
    This member is added by an implicit conversion from ShardRegion to Ensuring[ShardRegion] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  26. def ensuring(cond: Boolean): ShardRegion
    Implicit
    This member is added by an implicit conversion from ShardRegion to Ensuring[ShardRegion] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  27. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  29. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  30. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ShardRegion to StringFormat[ShardRegion] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  32. def getShard(id: ShardId): Option[ActorRef]
  33. var gracefulShutdownInProgress: Boolean
  34. var handingOff: Set[ActorRef]
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  36. def initializeShard(id: ShardId, shard: ActorRef): Unit
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. def log: LoggingAdapter
    Definition Classes
    ActorLogging
  39. var loggedFullBufferWarning: Boolean
  40. def matchingRole(member: Member): Boolean
  41. var membersByAge: SortedSet[Member]
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  45. 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] )
  46. def postStop(): Unit

    User overridable callback.

    User overridable callback.

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

    Definition Classes
    ShardRegion → Actor
  47. def preRestart(reason: Throwable, message: Option[Any]): Unit

    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] )
  48. 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
    ShardRegion → Actor
  49. def receive: PartialFunction[Any, Unit]

    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
    ShardRegion → Actor
  50. def receiveClusterEvent(evt: ClusterDomainEvent): Unit
  51. def receiveClusterState(state: CurrentClusterState): Unit
  52. def receiveCommand(cmd: ShardRegionCommand): Unit
  53. def receiveCoordinatorMessage(msg: CoordinatorMessage): Unit
  54. def receiveQuery(query: ShardRegionQuery): Unit
  55. def receiveTerminated(ref: ActorRef): Unit
  56. var regionByShard: Map[ShardId, ActorRef]
  57. var regions: Map[ActorRef, Set[ShardId]]
  58. def register(): Unit
  59. def registrationMessage: Any
  60. def replyToRegionStateQuery(ref: ActorRef): Unit
  61. def replyToRegionStatsQuery(ref: ActorRef): Unit
  62. def requestShardBufferHomes(): Unit
  63. var retryCount: Int
  64. val retryTask: Cancellable
  65. 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
  66. def sendGracefulShutdownToCoordinator(): Unit
  67. 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
  68. var shardBuffers: MessageBufferMap[ShardId]
  69. var shards: Map[ShardId, ActorRef]
  70. var shardsByRef: Map[ActorRef, ShardId]
  71. var startingShards: Set[ShardId]
  72. 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
  73. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  74. def toString(): String
    Definition Classes
    AnyRef → Any
  75. 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
  76. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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
    @throws( ... )
  79. def →[B](y: B): (ShardRegion, B)
    Implicit
    This member is added by an implicit conversion from ShardRegion to ArrowAssoc[ShardRegion] 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 ShardRegion to any2stringadd[ShardRegion]

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

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

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

Ungrouped