[KAFKA-6456] Improve JavaDoc of SourceTask#poll() to discourage indefinite blocking

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.0.0
• Fix Version/s: 1.1.0
• Component/s: connect
• Assignee: Unassigned
• Reporter: Gunnar Morling
• Created: 17/Jan/18 09:24
• Updated: 18/Jan/18 17:57
• Resolved: 18/Jan/18 17:57

Description

The docs of poll() currently say "This method should block if no data is currently available". This causes the task from transitioning to PAUSED state, if there's no data available for a longer period of time. I'd therefore suggest to reword like this:

This method should block if no data is currently available but return control to Kafka Connect periodically (by returning null).

Issue Links

• links to: GitHub Pull Request #4432