Clarify sharding stop message being local

This commit is contained in:
Johan Andrén 2021-06-30 16:06:41 +02:00 committed by GitHub
parent 8573c70883
commit e8e667c228
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -284,6 +284,8 @@ the entity when it's supposed to stop itself due to rebalance or passivation. If
it will be stopped automatically without receiving a specific message. It can be useful to define a custom stop it will be stopped automatically without receiving a specific message. It can be useful to define a custom stop
message if the entity needs to perform some asynchronous cleanup or interactions before stopping. message if the entity needs to perform some asynchronous cleanup or interactions before stopping.
The stop message is only sent locally, from the shard to the entity so does not require an entity id to end up in the right actor. When using a custom `ShardingMessageExtractor` without envelopes, the extractor will still have to handle the stop message type to please the compiler, even though it will never actually be passed to the extractor.
### Automatic Passivation ### Automatic Passivation
The entities are automatically passivated if they haven't received a message within the duration configured in The entities are automatically passivated if they haven't received a message within the duration configured in