summaryrefslogtreecommitdiff
path: root/kafka/client_async.py
diff options
context:
space:
mode:
authorJeff Widman <jeff@jeffwidman.com>2018-06-26 12:47:12 -0700
committerJeff Widman <jeff@jeffwidman.com>2018-06-26 12:48:41 -0700
commit9ac3cb1ec220ff9968a8b003b02e98dd11cc486b (patch)
tree6290be5e8e5b99eb29bf996a97de6e2ab445896b /kafka/client_async.py
parentbc4cc434cddf403a35d0393d68ecfdbfad17c8e5 (diff)
downloadkafka-python-9ac3cb1ec220ff9968a8b003b02e98dd11cc486b.tar.gz
Document connections_max_idle_ms
This was added in #1068 but never documented. Fix #1497
Diffstat (limited to 'kafka/client_async.py')
-rw-r--r--kafka/client_async.py5
1 files changed, 5 insertions, 0 deletions
diff --git a/kafka/client_async.py b/kafka/client_async.py
index a9704fa..5a16f6b 100644
--- a/kafka/client_async.py
+++ b/kafka/client_async.py
@@ -79,6 +79,11 @@ class KafkaClient(object):
the computed value. Default: 1000.
request_timeout_ms (int): Client request timeout in milliseconds.
Default: 30000.
+ connections_max_idle_ms: Close idle connections after the number of
+ milliseconds specified by this config. The broker closes idle
+ connections after connections.max.idle.ms, so this avoids hitting
+ unexpected socket disconnected errors on the client.
+ Default: 540000
retry_backoff_ms (int): Milliseconds to backoff when retrying on
errors. Default: 100.
max_in_flight_requests_per_connection (int): Requests are pipelined