raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Merge pull request #30351 from akka/johanandren-patch-1

Browse source 
Clarify sharding stop message being local
This commit is contained in:
Patrik Nordwall 2021-07-05 15:12:21 +02:00 • committed by GitHub
commit edf68f32ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
akka-docs/src/main/paradox/typed/cluster-sharding.md
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
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
The entities are automatically passivated if they haven't received a message within the duration configured in