Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Documented parameters of callbacks
  • Loading branch information
edenhill committed Jul 13, 2016
commit d7239ee7842f4139b4456288e46d78ade0189d5e
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,14 +78,14 @@ The Python bindings also provide some additional configuration properties:
* ``default.topic.config``: value is a dict of topic-level configuration
properties that are applied to all used topics for the instance.

* ``error_cb``: Callback for generic/global error events. This callback is served by
* ``error_cb(kafka.KafkaError)``: Callback for generic/global error events. This callback is served by
poll().

* ``on_delivery`` (**Producer**): value is a Python function reference
* ``on_delivery(kafka.KafkaError, kafka.Message)`` (**Producer**): value is a Python function reference
that is called once for each produced message to indicate the final
delivery result (success or failure).
This property may also be set per-message by passing ``callback=callable``
(or ``on_delivery=callable``) to the confluent_kafka.Producer.produce() function.

* ``on_commit`` (**Consumer**): Callback used to indicate success or failure
* ``on_commit(kafka.KafkaError, list(kafka.TopicPartition))`` (**Consumer**): Callback used to indicate success or failure
of commit requests.