Packages

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. 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 Entity[M, E] toany2stringadd[Entity[M, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Entity[M, E], B)
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toArrowAssoc[Entity[M, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val allocationStrategy: Optional[ShardAllocationStrategy]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. val createBehavior: Function[EntityContext[M], Behavior[M]]
  10. val dataCenter: Optional[String]
  11. def ensuring(cond: (Entity[M, E]) => Boolean, msg: => Any): Entity[M, E]
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toEnsuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Entity[M, E]) => Boolean): Entity[M, E]
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toEnsuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Entity[M, E]
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toEnsuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Entity[M, E]
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toEnsuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. val entityProps: Props
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. val messageExtractor: Optional[ShardingMessageExtractor[E, M]]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  25. val role: Optional[String]
  26. val settings: Optional[ClusterShardingSettings]
  27. val stopMessage: Optional[M]
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. val typeKey: EntityTypeKey[M]
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. 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.

  35. def withDataCenter(newDataCenter: String): 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.

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

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

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

  38. def withRole(role: String): Entity[M, E]

    Run the Entity actors on nodes with the given role.

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

    Additional settings, typically loaded from configuration.

  40. 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 finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toStringFormat[Entity[M, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Entity[M, E], B)
    Implicit
    This member is added by an implicit conversion from Entity[M, E] toArrowAssoc[Entity[M, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEntity[M, E] to any2stringadd[Entity[M, E]]

Inherited by implicit conversion StringFormat fromEntity[M, E] to StringFormat[Entity[M, E]]

Inherited by implicit conversion Ensuring fromEntity[M, E] to Ensuring[Entity[M, E]]

Inherited by implicit conversion ArrowAssoc fromEntity[M, E] to ArrowAssoc[Entity[M, E]]

Ungrouped