Skip to content

Commit

Permalink
[doc][client] Add timestamp format description for seek method of the…
Browse files Browse the repository at this point in the history
… Consumer and Reader (apache#16648)

### Motivation

There are many timestamp formats, we need to specify the required timestamp format for the seek method of the Consumer and Reader.

### Modifications
* Add a description requiring the timestamp format should be Unix Time in milliseconds for the seek method of the Consumer and Reader.
  • Loading branch information
RobertIndie authored Jul 25, 2022
1 parent 77d5d67 commit 22e8cb2
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -708,6 +708,7 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,
*
* @param timestamp
* the message publish time where to reposition the subscription
* The timestamp format should be Unix time in milliseconds.
*/
void seek(long timestamp) throws PulsarClientException;

Expand Down Expand Up @@ -765,6 +766,7 @@ CompletableFuture<Void> reconsumeLaterCumulativeAsync(Message<?> message,
*
* @param timestamp
* the message publish time where to reposition the subscription
* The timestamp format should be Unix time in milliseconds.
* @return a future to track the completion of the seek operation
*/
CompletableFuture<Void> seekAsync(long timestamp);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ public interface Reader<T> extends Closeable {
* the seek() on the individual partitions.
*
* @param timestamp the message publish time where to reposition the reader
* The timestamp format should be Unix time in milliseconds.
*/
void seek(long timestamp) throws PulsarClientException;

Expand Down Expand Up @@ -212,6 +213,7 @@ public interface Reader<T> extends Closeable {
*
* @param timestamp
* the message publish time where to position the reader
* The timestamp format should be Unix time in milliseconds.
* @return a future to track the completion of the seek operation
*/
CompletableFuture<Void> seekAsync(long timestamp);
Expand Down

0 comments on commit 22e8cb2

Please sign in to comment.