summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2016-04-04 23:09:46 -0700
committerDana Powers <dana.powers@gmail.com>2016-04-04 23:09:46 -0700
commitd81963a919fa8161c94b5bef5e6de0697b91c4a6 (patch)
tree7c23ab3cdd2edb4ecc3249982b2252e3c5927b58
parentff10ccf3cef3f5602f717d6b062c78fe8e47a4d2 (diff)
downloadkafka-python-d81963a919fa8161c94b5bef5e6de0697b91c4a6.tar.gz
Update max.block.ms docstring
-rw-r--r--kafka/producer/kafka.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/kafka/producer/kafka.py b/kafka/producer/kafka.py
index 2a16fd8..e1a0374 100644
--- a/kafka/producer/kafka.py
+++ b/kafka/producer/kafka.py
@@ -162,9 +162,11 @@ class KafkaProducer(object):
will block up to max_block_ms, raising an exception on timeout.
In the current implementation, this setting is an approximation.
Default: 33554432 (32MB)
- max_block_ms (int): Number of milliseconds to block during send()
- when attempting to allocate additional memory before raising an
- exception. Default: 60000.
+ max_block_ms (int): Number of milliseconds to block during send() and
+ partitions_for(). These methods can be blocked either because the
+ buffer is full or metadata unavailable. Blocking in the
+ user-supplied serializers or partitioner will not be counted against
+ this timeout. Default: 60000.
max_request_size (int): The maximum size of a request. This is also
effectively a cap on the maximum record size. Note that the server
has its own cap on record size which may be different from this.