[GitHub] merlimat closed pull request #1389: Fix Reader.readNext() java docs

[GitBox <gi...@apache.org>]

merlimat closed pull request #1389: Fix Reader.readNext() java docs
URL: https://github.com/apache/incubator-pulsar/pull/1389
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/pulsar-client/src/main/java/org/apache/pulsar/client/api/Reader.java b/pulsar-client/src/main/java/org/apache/pulsar/client/api/Reader.java
index f343c90a3..44c0d0a55 100644
--- a/pulsar-client/src/main/java/org/apache/pulsar/client/api/Reader.java
+++ b/pulsar-client/src/main/java/org/apache/pulsar/client/api/Reader.java
@@ -42,9 +42,10 @@
     Message<T> readNext() throws PulsarClientException;
 
     /**
-     * Read the next message in the topic.
+     * Read the next message in the topic waiting for a maximum of timeout
+     * time units. Returns null if no message is recieved in that time.
      *
-     * @return the next messasge
+     * @return the next message(Could be null if none received in time)
      * @throws PulsarClientException
      */
     Message<T> readNext(int timeout, TimeUnit unit) throws PulsarClientException;


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services