You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by ew...@apache.org on 2016/01/11 07:14:28 UTC
kafka git commit: KAFKA-3044: Re-word consumer.poll behaviour
Repository: kafka
Updated Branches:
refs/heads/trunk 36f5c46a5 -> 7059158c4
KAFKA-3044: Re-word consumer.poll behaviour
https://issues.apache.org/jira/browse/KAFKA-3044
Author: Praveen Devarao <pr...@in.ibm.com>
Reviewers: Ewen Cheslack-Postava <ew...@confluent.io>
Closes #751 from praveend/poll_doc_changes
Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/7059158c
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/7059158c
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/7059158c
Branch: refs/heads/trunk
Commit: 7059158c48ec05288c0b45ccac05d62b38f1bf76
Parents: 36f5c46
Author: Praveen Devarao <pr...@in.ibm.com>
Authored: Sun Jan 10 22:13:54 2016 -0800
Committer: Ewen Cheslack-Postava <me...@ewencp.org>
Committed: Sun Jan 10 22:13:54 2016 -0800
----------------------------------------------------------------------
.../java/org/apache/kafka/clients/consumer/KafkaConsumer.java | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kafka/blob/7059158c/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
----------------------------------------------------------------------
diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java b/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
index 7ea293d..2f78139 100644
--- a/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
+++ b/clients/src/main/java/org/apache/kafka/clients/consumer/KafkaConsumer.java
@@ -798,8 +798,9 @@ public class KafkaConsumer<K, V> implements Consumer<K, V> {
* offset for the subscribed list of partitions
*
*
- * @param timeout The time, in milliseconds, spent waiting in poll if data is not available. If 0, returns
- * immediately with any records that are available now. Must not be negative.
+ * @param timeout The time, in milliseconds, spent waiting in poll if data is not available in the buffer.
+ * If 0, returns immediately with any records that are available currently in the buffer, else returns empty.
+ * Must not be negative.
* @return map of topic to records since the last fetch for the subscribed list of topics and partitions
*
* @throws org.apache.kafka.clients.consumer.InvalidOffsetException if the offset for a partition or set of