final class Entity[M, E] extends AnyRef
Defines how the entity should be created. Used in ClusterSharding#init.
- Source
- ClusterSharding.scala
- Alphabetic
- By Inheritance
- Entity
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Entity[M, E], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val allocationStrategy: Option[ShardAllocationStrategy]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- val createBehavior: (EntityContext) ⇒ Behavior[M]
- def ensuring(cond: (Entity[M, E]) ⇒ Boolean, msg: ⇒ Any): Entity[M, E]
- def ensuring(cond: (Entity[M, E]) ⇒ Boolean): Entity[M, E]
- def ensuring(cond: Boolean, msg: ⇒ Any): Entity[M, E]
- def ensuring(cond: Boolean): Entity[M, E]
- val entityProps: Props
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val messageExtractor: Option[ShardingMessageExtractor[E, M]]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val settings: Option[ClusterShardingSettings]
- val stopMessage: Option[M]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
- val typeKey: EntityTypeKey[M]
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withAllocationStrategy(newAllocationStrategy: ShardAllocationStrategy): Entity[M, E]
Allocation strategy which decides on which nodes to allocate new shards, ClusterSharding#defaultShardAllocationStrategy is used if this is not specified.
-
def
withEntityProps(newEntityProps: Props): Entity[M, E]
akka.actor.typed.Props of the entity actors, such as dispatcher settings.
-
def
withMessageExtractor[Envelope](newExtractor: ShardingMessageExtractor[Envelope, M]): Entity[M, Envelope]
If a
messageExtractor
is not specified the messages are sent to the entities by wrapping them in ShardingEnvelope with the entityId of the recipient actor.If a
messageExtractor
is not specified the messages are sent to the entities by wrapping them in ShardingEnvelope with the entityId of the recipient actor. That envelope is used by the HashCodeMessageExtractor for extracting entityId and shardId. The number of shards is then defined bynumberOfShards
inClusterShardingSettings
, which by default is configured withakka.cluster.sharding.number-of-shards
. -
def
withSettings(newSettings: ClusterShardingSettings): Entity[M, E]
Additional settings, typically loaded from configuration.
-
def
withStopMessage(newStopMessage: M): Entity[M, E]
Message sent to an entity to tell it to stop, e.g.
Message sent to an entity to tell it to stop, e.g. when rebalanced or passivated. If this is not defined it will be stopped automatically. It can be useful to define a custom stop message if the entity needs to perform some asynchronous cleanup or interactions before stopping.
- def →[B](y: B): (Entity[M, E], B)