[improve][client] Document Java Client's Seek logic thread-safety improved in #20242 #20284
Conversation
This file contains 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
github-actions
bot
added
the
doc
tisonkun
reviewed
May 15, 2023
| @@ -523,11 +523,15 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message, | |||
|
|
|||
| /** | |||
| * The asynchronous version of {@link Consumer#seek(MessageId)}. | |||
| * <p> | |||
| * If there is already a seek operation in progress, the method will log a warning and return a canceled future. | |||
There was a problem hiding this comment.
Suggested change
| * If there is already a seek operation in progress, the method will log a warning and return a canceled future. | |
| * If there is already a seek operation in progress, the method will log a warning and return a future completed exceptionally. |
See #20321
There was a problem hiding this comment.
Oh okay, will do 👍🏻👍🏻
tisonkun
reviewed
May 15, 2023
| */ | ||
| CompletableFuture<Void> seekAsync(MessageId messageId); | ||
|
|
||
| /** | ||
| * Reset the subscription associated with this consumer to a specific message publish time. | ||
| * <p> | ||
| * If there is already a seek operation in progress, the method will log a warning and return a canceled future. |
There was a problem hiding this comment.
Suggested change
| * If there is already a seek operation in progress, the method will log a warning and return a canceled future. | |
| * If there is already a seek operation in progress, the method will log a warning and return a future completed exceptionally. |
tisonkun
approved these changes
May 16, 2023
pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Consumer.java
Outdated
Show resolved
Hide resolved
michaeljmarshall
approved these changes
May 16, 2023
Please fix only the reported style violations. You can check locally by running: |
|
My apologies 🙏🏼 Will do now and re-request review shortly, @tisonkun. |
tisonkun
approved these changes
May 17, 2023
Codecov Report
@@ Coverage Diff @@
## master #20284 +/- ##
=============================================
+ Coverage 37.61% 72.91% +35.30%
- Complexity 12589 31951 +19362
=============================================
Files 1691 1868 +177
Lines 129028 138663 +9635
Branches 14066 15248 +1182
=============================================
+ Hits 48530 101112 +52582
+ Misses 74183 29484 -44699
- Partials 6315 8067 +1752
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Master Issue: #19671
Motivation
Improves JavaDoc describing changes made by PR #20242 as suggested by in review
EDIT: modified JavaDoc to also cover #20321 accordingly
Modifications
Add JavaDoc regarding thready-safety to the methods in scope of #20242
Verifying this change
This change is a trivial rework only adds JavaDoc
Does this pull request potentially affect one of the following parts:
If the box was checked, please highlight the changes
Documentation
docdoc-requireddoc-not-neededdoc-completeMatching PR in forked repository
PR in forked repository: https://github.com/JooHyukKim/pulsar/pull/2