diff options
| author | Dana Powers <dana.powers@gmail.com> | 2016-07-08 16:04:09 -0700 |
|---|---|---|
| committer | Dana Powers <dana.powers@gmail.com> | 2016-07-08 16:04:09 -0700 |
| commit | c921b2ac4cec7459f8a84a0583e8892e6b3f2c6f (patch) | |
| tree | 29a853a2c71486d158285c8e79a3d5926790a52d | |
| parent | 77971ac093add6d5b292e5f91bcefd3f8df56102 (diff) | |
| download | kafka-python-c921b2ac4cec7459f8a84a0583e8892e6b3f2c6f.tar.gz | |
Update consumer_timeout_ms docstring per #749
| -rw-r--r-- | kafka/consumer/group.py | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/kafka/consumer/group.py b/kafka/consumer/group.py index 72f9dc8..8509999 100644 --- a/kafka/consumer/group.py +++ b/kafka/consumer/group.py @@ -120,9 +120,9 @@ class KafkaConsumer(six.Iterator): receive_buffer_bytes (int): The size of the TCP receive buffer (SO_RCVBUF) to use when reading data. Default: None (relies on system defaults). The java client defaults to 32768. - consumer_timeout_ms (int): number of millisecond to throw a timeout - exception to the consumer if no message is available for - consumption. Default: -1 (dont throw exception) + consumer_timeout_ms (int): number of milliseconds to block during + message iteration before raising StopIteration (i.e., ending the + iterator). Default -1 (block forever). security_protocol (str): Protocol used to communicate with brokers. Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT. ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping |