haubur commented on code in PR #3913:
URL: https://github.com/apache/iggy/pull/3913#discussion_r3806047960
##########
core/sdk/src/clients/consumer.rs:
##########
@@ -1128,36 +1588,66 @@ impl Stream for IggyConsumer {
}
impl IggyConsumer {
+ /// Shuts the consumer down.
+ ///
+ /// Specifically, run shutdown and await before dropping the consumer to
+ /// - finish storing the offsets that are currently in-flight.
+ /// There are two background tasks that can have commits in flight. The
interval-based one
+ /// (only spawned for [`AutoCommit`] variants that carry an interval)
and the one driven by
+ /// [`AutoCommitWhen`]/[`AutoCommitAfter`] (always spawned). The
consumer waits for
+ /// `offset_drain_timeout` on each in turn before forcing it to abort.
+ /// Any offset that is not stored until then will be lost.
Review Comment:
Yes, this sentence needs to go. The final flush is already documented
correctly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
