summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2016-03-18 11:25:59 -0700
committerDana Powers <dana.powers@gmail.com>2016-03-18 11:25:59 -0700
commit4f8d9fa9dcbffb961b546465e51326dafeb2e6c1 (patch)
tree2b1a69fa5971253116db3bba0c2b9409e8590f15 /docs/index.rst
parent2f534c177fea1f70b6da691da323429bc5afda02 (diff)
downloadkafka-python-4f8d9fa9dcbffb961b546465e51326dafeb2e6c1.tar.gz
Add producer.flush() to usage docs
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index d8f826a..eb8f429 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -74,9 +74,13 @@ client. See `KafkaProducer <apidoc/KafkaProducer.html>`_ for more details.
>>> from kafka import KafkaProducer
>>> producer = KafkaProducer(bootstrap_servers='localhost:1234')
->>> producer.send('foobar', b'some_message_bytes')
+>>> for _ in range(100):
+... producer.send('foobar', b'some_message_bytes')
->>> # Blocking send
+>>> # Block until all pending messages are sent
+>>> producer.flush()
+
+>>> # Block until a single message is sent (or timeout)
>>> producer.send('foobar', b'another_message').get(timeout=60)
>>> # Use a key for hashed-partitioning