Class/Object

akka.cluster.sharding.typed.javadsl

Entity

Related Docs: object Entity | package javadsl

Permalink

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to any2stringadd[Entity[M, E]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Entity[M, E], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to ArrowAssoc[Entity[M, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. val allocationStrategy: Optional[ShardAllocationStrategy]

    Permalink
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val createBehavior: Function[EntityContext[M], Behavior[M]]

    Permalink
  10. def ensuring(cond: (Entity[M, E]) ⇒ Boolean, msg: ⇒ Any): Entity[M, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to Ensuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Entity[M, E]) ⇒ Boolean): Entity[M, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to Ensuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Entity[M, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to Ensuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Entity[M, E]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to Ensuring[Entity[M, E]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. val entityProps: Props

    Permalink
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to StringFormat[Entity[M, E]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. val messageExtractor: Optional[ShardingMessageExtractor[E, M]]

    Permalink
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. val settings: Optional[ClusterShardingSettings]

    Permalink
  27. val stopMessage: Optional[M]

    Permalink
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. val typeKey: EntityTypeKey[M]

    Permalink
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def withAllocationStrategy(newAllocationStrategy: ShardAllocationStrategy): Entity[M, E]

    Permalink

    Allocation strategy which decides on which nodes to allocate new shards, ClusterSharding#defaultShardAllocationStrategy is used if this is not specified.

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

    Permalink

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

  36. def withMessageExtractor[Envelope](newExtractor: ShardingMessageExtractor[Envelope, M]): Entity[M, Envelope]

    Permalink

    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.

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

    Permalink

    Additional settings, typically loaded from configuration.

  38. def withStopMessage(newStopMessage: M): Entity[M, E]

    Permalink

    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.

  39. def [B](y: B): (Entity[M, E], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Entity[M, E] to ArrowAssoc[Entity[M, E]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped