summaryrefslogtreecommitdiff
path: root/kafka/conn.py
diff options
context:
space:
mode:
authorDana Powers <dana.powers@rd.io>2016-01-07 17:03:08 -0800
committerDana Powers <dana.powers@rd.io>2016-01-07 17:03:08 -0800
commite080c6b0cdb54563e3c5ad595d582de26561d9f0 (patch)
tree0a3e686336667bb98c4be4bb324292fa29767a67 /kafka/conn.py
parentc8deb0c276d57209006eebdd910017846860a38d (diff)
downloadkafka-python-e080c6b0cdb54563e3c5ad595d582de26561d9f0.tar.gz
Docstring updates
Diffstat (limited to 'kafka/conn.py')
-rw-r--r--kafka/conn.py11
1 files changed, 10 insertions, 1 deletions
diff --git a/kafka/conn.py b/kafka/conn.py
index 9e8a16f..6ee5f5f 100644
--- a/kafka/conn.py
+++ b/kafka/conn.py
@@ -126,9 +126,17 @@ class BrokerConnection(object):
return False
def connected(self):
+ """Return True iff socket is connected."""
return self.state is ConnectionStates.CONNECTED
def close(self, error=None):
+ """Close socket and fail all in-flight-requests.
+
+ Arguments:
+ error (Exception, optional): pending in-flight-requests
+ will be failed with this exception.
+ Default: kafka.common.ConnectionError.
+ """
if self._sock:
self._sock.close()
self._sock = None
@@ -189,11 +197,12 @@ class BrokerConnection(object):
return future
def can_send_more(self):
+ """Return True unless there are max_in_flight_requests."""
max_ifrs = self.config['max_in_flight_requests_per_connection']
return len(self.in_flight_requests) < max_ifrs
def recv(self, timeout=0):
- """Non-blocking network receive
+ """Non-blocking network receive.
Return response if available
"""