Skip to content

Commit

Permalink
Update documentation for the API change.
Browse files Browse the repository at this point in the history
  • Loading branch information
resuna committed May 25, 2017
1 parent df15c85 commit e4817e1
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,8 @@ Methods of kafka topic consumer object

For each message received fill the array *array* with fields from the message containing the message *payload*, *partition*, *offset*, *topic* name and optional *key*, repeatedly executing *code* for each message received.

Kafka errors are returned as arrays containing the elements *error*, *code*, and *message*.

This method returns number of rows processed, 0 if the end of the partition is reached.

* *$topic* **info** **topic**
Expand Down Expand Up @@ -491,6 +493,8 @@ Queue objects support the following methods:

For each message received the array *array* is filled with fields from the message containing the message *payload*, *partition*, *offset*, *topic* name and optional *key*, repeatedly executing *code* for each message received.

Kafka errors are returned as arrays containing the elements *error*, *code*, and *message*.

The method returns number of rows processed.

* *$queue* **consume_callback** *?callback?*
Expand Down

0 comments on commit e4817e1

Please sign in to comment.