Class Entity<M,​E>

  • public final class Entity<M,​E>
    extends java.lang.Object
    Props of the entity actors, such as dispatcher settings.
    • Constructor Detail

      • Entity

        public Entity()
    • Method Detail

      • stopMessage

        public java.util.Optional<M> stopMessage()
      • entityProps

        public Props entityProps()
      • withEntityProps

        public Entity<M,​E> withEntityProps​(Props newEntityProps)
      • withSettings

        public Entity<M,​E> withSettings​(ClusterShardingSettings newSettings)
        Additional settings, typically loaded from configuration.
        newSettings - (undocumented)
      • withStopMessage

        public Entity<M,​E> withStopMessage​(M newStopMessage)
        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.
        newStopMessage - (undocumented)
      • withMessageExtractor

        public <Envelope> Entity<M,​Envelope> withMessageExtractor​(ShardingMessageExtractor<Envelope,​M> newExtractor)
        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.
        newExtractor - (undocumented)