Skip to content

Commit

Permalink
Add note about eof in consumer each method
Browse files Browse the repository at this point in the history
  • Loading branch information
thijsc committed Aug 15, 2019
1 parent 79e7f47 commit 45055f1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/rdkafka/consumer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,10 @@ def poll(timeout_ms)
# Poll for new messages and yield for each received one. Iteration
# will end when the consumer is closed.
#
# If `enable.partition.eof` is turned on in the config this will raise an
# error when an eof is reached, so you probably want to disable that when
# using this method of iteration.
#
# @raise [RdkafkaError] When polling fails
#
# @yieldparam message [Message] Received message
Expand Down

0 comments on commit 45055f1

Please sign in to comment.