Docs: Updated Cluster Distributed PubSub documentation #5566
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eaba
commented
Feb 3, 2022
| You publish messages by sending `DistributedPubSubMediator.Publish` message to the local mediator. | ||
|
|
||
| Actors are automatically removed from the registry when they are terminated, or you can explicitly remove entries with `DistributedPubSubMediator.Unsubscribe`. | ||
| Topic Actors are automatically removed from the registry when they are terminated - they are terminated if there are zero existing subscribers and no new subscription within a given deadline (the default is 2 minutes). You can change the deadline by setting `removed-time-to-live` to a desired duration. You can `Unsubscribe` from a topic with `DistributedPubSubMediator.Unsubscribe`. |
There was a problem hiding this comment.
@Aaronontheweb please correct if any error
| Typical usage of this mode is to broadcast messages to all replicas with the same path, e.g. 3 actors on different nodes that all perform the same actions, for redundancy. You can also optionally specify a property (`AllButSelf`) deciding if the message should be sent to a matching path on the self node or not. | ||
|
|
||
|
|
||
| ## Deadletter |
There was a problem hiding this comment.
@Aaronontheweb please correct if any!
|
I'll take a look @eaba |
Aaronontheweb
requested changes
Feb 4, 2022
| Topic Actors are automatically removed from the registry when they are terminated - they are terminated if there are zero existing subscribers and no new subscription within a given deadline (the default is 2 minutes). You can change the deadline by setting `removed-time-to-live` to a desired duration. You can `Unsubscribe` from a topic with `DistributedPubSubMediator.Unsubscribe`. | ||
|
|
||
| An example of a subscriber actor: | ||
|
|
There was a problem hiding this comment.
Need to turn this into a DocFx ref
There was a problem hiding this comment.
All code samples in this doc need to be updated
There was a problem hiding this comment.
... they are terminated; they are terminated ...
This would read better if it was two separate sentences. Also, the repeated verbiage looks out of place. It could be changed to something like
... they are terminated. Termination occurs when there are no ....
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #5563
Changes
Added Deadletter section