This is an automated email from the ASF dual-hosted git repository.
bogong pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new e0c546c249e [Doc] Add missing parameters to CommandAck (#15177)
e0c546c249e is described below
commit e0c546c249ee351327137f4e5166c6541b16da62
Author: Xiangying Meng <[email protected]>
AuthorDate: Wed Apr 20 09:47:38 2022 +0800
[Doc] Add missing parameters to CommandAck (#15177)
Fix https://github.com/apache/pulsar/issues/11272
### Motivation & Modification
Add missing parameters to CommandAck.
---
site2/docs/developing-binary-protocol.md | 25 ++++++++++++++++---------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/site2/docs/developing-binary-protocol.md
b/site2/docs/developing-binary-protocol.md
index e6c14c60b6b..482dcc804a6 100644
--- a/site2/docs/developing-binary-protocol.md
+++ b/site2/docs/developing-binary-protocol.md
@@ -361,7 +361,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -406,12 +406,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -446,9 +453,9 @@ messages are coming from the consumer.
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.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -460,8 +467,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -504,7 +511,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -566,7 +573,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
