merlimat closed pull request #2066: docs: Improve
RedeliverUnacknowledgedMessages binary protocol docs
URL: https://github.com/apache/incubator-pulsar/pull/2066
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/site/docs/latest/project/BinaryProtocol.md
b/site/docs/latest/project/BinaryProtocol.md
index 91a0ca313c..67b0113907 100644
--- a/site/docs/latest/project/BinaryProtocol.md
+++ b/site/docs/latest/project/BinaryProtocol.md
@@ -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.
@@ -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.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
