Improve Documentation about Acknowledgment.nack() #2906
Merged
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.
From the current documentation, it was not clear to me what is the effect of calling
Acknowledgment.nack()
when a listener is assigned to multiple topics and/or partitions.Looking at the implementation, I believe that calling
nack(Duration sleep)
will pause the entire listener for the specified sleep duration. Another option would have been that is only pauses reading from one partition or one topic, which other topics or partitions are still processed.With this PR, I attempt to make this more clear on the documentation page and in the JavaDoc of
Acknowledgment.nack()
.Please feel free to discuss, improve and correct me in case I'm wrong. Thank you!