Skip to content

Commit

Permalink
Improve RedeliverUnacknowledgedMessages binary protocol docs (apache#…
Browse files Browse the repository at this point in the history
…2066)

This updates the binary protocol documentation to mention the varying
behavior of `RedeliverUnacknowledgedMessages`, depending on the
subscription type.

Closes apache#2003
  • Loading branch information
awilliams authored and merlimat committed Jul 2, 2018
1 parent 7a10d93 commit 7559632
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions site/docs/latest/project/BinaryProtocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,8 +424,9 @@ A consumer can ask the broker to redeliver some or all of the pending messages
that were pushed to that particular consumer and not yet acknowledged.

The protobuf object accepts a list of message ids that the consumer wants to
be redelivered. If the list is empty, the broker will redeliver all the
pending messages.
be redelivered. The message ids will be honored by the broker only if the
subscription type is shared. For other subscription types or if the list
is empty, the broker will redeliver all the pending messages.

On redelivery, messages can be sent to the same consumer or, in the case of a
shared subscription, spread across all available consumers.
Expand All @@ -442,16 +443,16 @@ messages are coming from the consumer.

##### Command ConsumerStats

This command is sent by the client to retreive Subscriber and Consumer level
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
* `request_id` → Id of the request, used to correlate the request
* `request_id` → Id of the request, used to correlate the request
and the response.
* `consumer_id` → Id of an already established consumer.

##### Command ConsumerStatsResponse

This is the broker's response to ConsumerStats request by the client.
This is the broker's response to ConsumerStats request by the client.
It contains the Subscriber and Consumer level stats of the `consumer_id` sent in the request.
If the `error_code` or the `error_message` field is set it indicates that the request has failed.

Expand Down

0 comments on commit 7559632

Please sign in to comment.