final class Entity[M, E] extends AnyRef

Defines how the entity should be created. Used in ClusterSharding#init.

Source
ClusterSharding.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Entity
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. val allocationStrategy: [ShardAllocationStrategy]
  2. val createBehavior: (EntityContext[M]) => Behavior[M]
  3. val dataCenter: [DataCenter]
  4. val entityProps: Props
  5. val messageExtractor: [ShardingMessageExtractor[E, M]]
  6. val role: Option[String]
  7. val settings: [ClusterShardingSettings]
  8. val stopMessage: Option[M]
  9. val typeKey: EntityTypeKey[M]
  10. 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.

  11. def withEntityProps(newEntityProps: Props): Entity[M, E]

    akka.actor.typed.Props of the entity actors, such as dispatcher settings.

  12. 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 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 by numberOfShards in ClusterShardingSettings, which by default is configured with akka.cluster.sharding.number-of-shards.

  13. def withRole(newRole: String): Entity[M, E]

    Run the Entity actors on nodes with the given role.

  14. def withSettings(newSettings: ClusterShardingSettings): Entity[M, E]

    Additional settings, typically loaded from configuration.

  15. 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.

Deprecated Value Members

  1. def withDataCenter(newDataCenter: DataCenter): Entity[M, E]

    The data center of the cluster nodes where the cluster sharding is running.

    The data center of the cluster nodes where the cluster sharding is running. If the dataCenter is not specified then the same data center as current node. If the given dataCenter does not match the data center of the current node the ShardRegion will be started in proxy mode.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead