Skip to content

[improve][client] Document Java Client's Seek logic thread-safety improved in #20242 #20284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Technoboy- merged 4 commits into from
May 17, 2023
Merged

[improve][client] Document Java Client's Seek logic thread-safety improved in #20242 #20284

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a227d6
Add JavaDoc regarding PR #20242
JooHyukKim May 9, 2023
2d0ed78
Update JavaDoc to the latest behavior
JooHyukKim May 15, 2023
3673c25
Add descriptions to seek methods also.
JooHyukKim May 16, 2023
ad66df2
Fix checkstyle white spaces
JooHyukKim May 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Consumer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,9 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,

/**
* Reset the subscription associated with this consumer to a specific message id.
* <p>
* If there is already a seek operation in progress, the method will log a warning and
* return a future completed exceptionally.
*
* <p>The message id can either be a specific message or represent the first or last messages in the topic.
* <ul>
Expand All @@ -483,6 +486,9 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,

/**
* 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 future completed exceptionally.
*
* @param timestamp
* the message publish time where to reposition the subscription
Expand All @@ -493,6 +499,10 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,
/**
* Reset the subscription associated with this consumer to a specific message ID or message publish time.
* <p>
* If there is already a seek operation in progress, the method will log a warning and
* return a future completed exceptionally.
*
* <p>
* The Function input is topic+partition. It returns only timestamp or MessageId.
* <p>
* The return value is the seek position/timestamp of the current partition.
Expand Down Expand Up @@ -523,11 +533,17 @@ 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 future completed exceptionally.
*/
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 future completed exceptionally.
*
* @param timestamp
* the message publish time where to reposition the subscription
Expand Down