Documentation

dashbitco · Apr 21, 2024 · 2bd8fc5 · 2bd8fc5
1 parent fd27f86
commit 2bd8fc5
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/broadway_kafka/producer.ex b/lib/broadway_kafka/producer.ex
@@ -139,6 +139,9 @@ defmodule BroadwayKafka.Producer do
     * `:request_timeout` - Optional. Time in milliseconds to be used as a timeout for waiting response from Kafka.
     Default is to use `:brod`'s default timeout which is currently 240 seconds.
 
+    * `:extra_sock_opts` - Optional. `gen_tcp` socket options. [More info](https://www.erlang.org/doc/man/gen_tcp.html#type-option).
+    Set to `[:inet6]` if your Kafka broker uses IPv6.
+
   > **Note**: Currently, Broadway does not support all options provided by `:brod`. If you
   have a scenario where you need any extra option that is not listed above, please open an
   issue, so we can consider adding it.