Type Members

1.  final case class ClusterShardingStats(regions: Map[Address, ShardRegionStats]) extends ClusterShardingSerializable with Product with Serializable

   Reply to GetClusterShardingStats, contains statistics about all the sharding regions in the cluster.

   Reply to GetClusterShardingStats, contains statistics about all the sharding regions in the cluster.

   Annotations

   @SerialVersionUID()

2.  final case class CurrentRegions(regions: Set[Address]) extends ClusterShardingSerializable with Product with Serializable

   Reply to GetCurrentRegions

   Reply to GetCurrentRegions

   Annotations

   @SerialVersionUID()

3.  final class CurrentShardRegionState extends ClusterShardingSerializable with Product

   Reply to GetShardRegionState$

   Reply to GetShardRegionState$

   If gathering the shard information times out the set of shards will be empty.

   Annotations

   @SerialVersionUID()

4.  type EntityId = String

   Marker type of entity identifier (String).

5.  type ExtractEntityId = PartialFunction[Msg, (EntityId, Msg)]

   Interface of the partial function used by the ShardRegion to extract the entity id and the message to send to the entity from an incoming message.

   Interface of the partial function used by the ShardRegion to extract the entity id and the message to send to the entity from an incoming message. The implementation is application specific. If the partial function does not match the message will be unhandled, i.e. posted as Unhandled messages on the event stream. Note that the extracted message does not have to be the same as the incoming message to support wrapping in message envelope that is unwrapped before sending to the entity actor.

6.  type ExtractShardId = (Msg) => ShardId

   Interface of the function used by the ShardRegion to extract the shard id from an incoming message.

   Interface of the function used by the ShardRegion to extract the shard id from an incoming message. Only messages that passed the ExtractEntityId will be used as input to this function.

7.  case class GetClusterShardingStats(timeout: FiniteDuration) extends ShardRegionQuery with ClusterShardingSerializable with Product with Serializable

   Send this message to the ShardRegion actor to request for ClusterShardingStats, which contains statistics about the currently running sharded entities in the entire cluster.

   Send this message to the ShardRegion actor to request for ClusterShardingStats, which contains statistics about the currently running sharded entities in the entire cluster. If the timeout is reached without answers from all shard regions the reply will contain an empty map of regions.

   Intended for testing purpose to see when cluster sharding is "ready" or to monitor the state of the shard regions.

   Annotations

   @SerialVersionUID()

8.  abstract class HashCodeMessageExtractor extends MessageExtractor

   Convenience implementation of ShardRegion.MessageExtractor that construct shardId based on the hashCode of the entityId.

   Convenience implementation of ShardRegion.MessageExtractor that construct shardId based on the hashCode of the entityId. The number of unique shards is limited by the given maxNumberOfShards.

9.  trait MessageExtractor extends AnyRef

   Java API: Interface of functions to extract entity id, shard id, and the message to send to the entity from an incoming message.

10.  type Msg = Any

    Marker type of application messages (Any).

11.  final case class Passivate(stopMessage: Any) extends ShardRegionCommand with Product with Serializable

    If the state of the entities are persistent you may stop entities that are not used to reduce memory consumption.

    If the state of the entities are persistent you may stop entities that are not used to reduce memory consumption. This is done by the application specific implementation of the entity actors for example by defining receive timeout (context.setReceiveTimeout). If a message is already enqueued to the entity when it stops itself the enqueued message in the mailbox will be dropped. To support graceful passivation without losing such messages the entity actor can send this Passivate message to its parent ShardRegion. The specified wrapped stopMessage will be sent back to the entity, which is then supposed to stop itself. Incoming messages will be buffered by the ShardRegion between reception of Passivate and termination of the entity. Such buffered messages are thereafter delivered to a new incarnation of the entity.

    pekko.actor.PoisonPill is a perfectly fine stopMessage.

    Annotations

    @SerialVersionUID()

12.  final case class SetActiveEntityLimit(perRegionLimit: Int) extends Product with Serializable

    API MAY CHANGE: Messages for passivation strategies may change after additional testing and feedback.

    API MAY CHANGE: Messages for passivation strategies may change after additional testing and feedback.

    When limit-based automatic passivation is enabled, set a new active entity limit for a shard region.

    Annotations

    @ApiMayChange()

13.  type ShardId = String

    Marker type of shard identifier (String).

14.  final case class ShardInitialized(shardId: ShardId) extends Product with Serializable

    We must be sure that a shard is initialized before to start send messages to it.

    We must be sure that a shard is initialized before to start send messages to it. Shard could be terminated during initialization.

15.  sealed trait ShardRegionCommand extends AnyRef
16.  sealed trait ShardRegionQuery extends AnyRef
17.  final class ShardRegionStats extends ClusterShardingSerializable with Product
    Annotations

    @SerialVersionUID()

18.  final case class ShardState(shardId: ShardId, entityIds: Set[EntityId]) extends Product with Serializable

    Annotations

    @SerialVersionUID()

19.  final case class StartEntity(entityId: EntityId) extends ClusterShardingSerializable with Product with Serializable

    When remembering entities and a shard is started, each entity id that needs to be running will trigger this message being sent through sharding.

    When remembering entities and a shard is started, each entity id that needs to be running will trigger this message being sent through sharding. For this to work the message *must* be handled by the shard id extractor.

20.  final case class StartEntityAck(entityId: EntityId, shardId: ShardId) extends ClusterShardingSerializable with DeadLetterSuppression with Product with Serializable

    Sent back when a ShardRegion.StartEntity message was received and triggered the entity to start (it does not guarantee the entity successfully started)