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
- Alphabetic
- By Inheritance
- ShardRegion
- ActorLogging
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ShardRegion(typeName: String, entityProps: Option[Props], settings: ClusterShardingSettings, coordinatorPath: String, extractEntityId: ExtractEntityId, extractShardId: ExtractShardId, handOffStopMessage: Any)
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Value Members
- val ageOrdering: Ordering[Member]
- def askAllShards[T](msg: Any)(implicit arg0: ClassTag[T]): Future[Seq[(ShardId, T)]]
- def bufferMessage(shardId: ShardId, msg: Any, snd: ActorRef): Unit
- def changeMembers(newMembers: SortedSet[Member]): Unit
- val cluster: Cluster
-
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.
getContextreturns a akka.actor.UntypedActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
- var coordinator: Option[ActorRef]
- def coordinatorSelection: Option[ActorSelection]
- def deliverBufferedMessages(shardId: ShardId, receiver: ActorRef): Unit
- def deliverMessage(msg: Any, snd: ActorRef): Unit
- def getShard(id: ShardId): Option[ActorRef]
- var gracefulShutdownInProgress: Boolean
- var handingOff: Set[ActorRef]
- def initializeShard(id: ShardId, shard: ActorRef): Unit
-
def
log: LoggingAdapter
- Definition Classes
- ActorLogging
- var loggedFullBufferWarning: Boolean
- def matchingRole(member: Member): Boolean
- var membersByAge: SortedSet[Member]
-
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] )
-
def
postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- ShardRegion → Actor
-
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] )
-
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
-
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
- def receiveClusterEvent(evt: ClusterDomainEvent): Unit
- def receiveClusterState(state: CurrentClusterState): Unit
- def receiveCommand(cmd: ShardRegionCommand): Unit
- def receiveCoordinatorMessage(msg: CoordinatorMessage): Unit
- def receiveQuery(query: ShardRegionQuery): Unit
- def receiveTerminated(ref: ActorRef): Unit
- var regionByShard: Map[ShardId, ActorRef]
- var regions: Map[ActorRef, Set[ShardId]]
- def register(): Unit
- def registrationMessage: Any
- def replyToRegionStateQuery(ref: ActorRef): Unit
- def replyToRegionStatsQuery(ref: ActorRef): Unit
- def requestShardBufferHomes(): Unit
- var retryCount: Int
- val retryTask: Cancellable
-
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
- def sendGracefulShutdownToCoordinator(): Unit
-
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
deadLettersin 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
- var shardBuffers: MessageBufferMap[ShardId]
- var shards: Map[ShardId, ActorRef]
- var shardsByRef: Map[ActorRef, ShardId]
- var startingShards: Set[ShardId]
-
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
-
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