Skip to content

Commit d4175f2

Browse files
garyrussellartembilan
authored andcommitted
GH-1014: Fix setSyncCommits Javadocs
Resolves #1014 **cherry-pick to 2.2.x** # Conflicts: # spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerProperties.java
1 parent 02de8a2 commit d4175f2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

spring-kafka/src/main/java/org/springframework/kafka/listener/ContainerProperties.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,18 +347,20 @@ public void setConsumerRebalanceListener(ConsumerRebalanceListener consumerRebal
347347
/**
348348
* Set the commit callback; by default a simple logging callback is used to log
349349
* success at DEBUG level and failures at ERROR level.
350+
* Used when {@link #setSyncCommits(boolean) syncCommits} is false.
350351
* @param commitCallback the callback.
352+
* @see #setSyncCommits(boolean)
351353
*/
352354
public void setCommitCallback(OffsetCommitCallback commitCallback) {
353355
this.commitCallback = commitCallback;
354356
}
355357

356358
/**
357359
* Set whether or not to call consumer.commitSync() or commitAsync() when the
358-
* container is responsible for commits. Default true. See
359-
* https://github.com/spring-projects/spring-kafka/issues/62 At the time of
360-
* writing, async commits are not entirely reliable.
360+
* container is responsible for commits. Default true.
361361
* @param syncCommits true to use commitSync().
362+
* @see #setCommitCallback(OffsetCommitCallback)
363+
* @see #setCommitLogLevel(org.springframework.kafka.support.LogIfLevelEnabled.Level)
362364
*/
363365
public void setSyncCommits(boolean syncCommits) {
364366
this.syncCommits = syncCommits;

0 commit comments

Comments
 (0)