Browse Source

MINOR: clarify KafkaStreams.close javadoc (#7605)

Reviewers: Bill Bejeck <bill@confluent.io>, Boyang Chen <boyang@confluent.io>, Matthias J. Sax <matthias@confluent.io>
pull/7676/head
John Roesler 5 years ago committed by Matthias J. Sax
parent
commit
38ed69241f
  1. 3
      streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java

3
streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java

@ -969,7 +969,8 @@ public class KafkaStreams implements AutoCloseable { @@ -969,7 +969,8 @@ public class KafkaStreams implements AutoCloseable {
/**
* Shutdown this {@code KafkaStreams} by signaling all the threads to stop, and then wait up to the timeout for the
* threads to join.
* A {@code timeout} of 0 means to wait forever.
* A {@code timeout} of Duration.ZERO (or any other zero duration) makes the close operation asynchronous.
* Negative-duration timeouts are rejected.
*
* @param timeout how long to wait for the threads to shutdown
* @return {@code true} if all threads were successfully stopped&mdash;{@code false} if the timeout was reached

Loading…
Cancel
Save