openstack/deb-python-kafka
Code Issues Proposed changes

Update consumer_timeout_ms docstring per #749

Browse Source
This commit is contained in:
Dana Powers
2016-07-08 16:04:09 -07:00
parent 77971ac093
commit c921b2ac4c
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
kafka/consumer/group.py
View File

@@ -120,9 +120,9 @@ class KafkaConsumer(six.Iterator):
receive_buffer_bytes (int): The size of the TCP receive buffer receive_buffer_bytes (int): The size of the TCP receive buffer
(SO_RCVBUF) to use when reading data. Default: None (relies on (SO_RCVBUF) to use when reading data. Default: None (relies on
system defaults). The java client defaults to 32768. system defaults). The java client defaults to 32768.
consumer_timeout_ms (int): number of millisecond to throw a timeout consumer_timeout_ms (int): number of milliseconds to block during
exception to the consumer if no message is available for message iteration before raising StopIteration (i.e., ending the
consumption. Default: -1 (dont throw exception) iterator). Default -1 (block forever).
security_protocol (str): Protocol used to communicate with brokers. security_protocol (str): Protocol used to communicate with brokers.
Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT. Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping