You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/05/09 12:03:15 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar(#0975cdc)
This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 9e2a6f3e762 Docs sync done from apache/pulsar(#0975cdc)
9e2a6f3e762 is described below
commit 9e2a6f3e762162b6d0a67f4831f77f044d18b21d
Author: Pulsar Site Updater <de...@pulsar.apache.org>
AuthorDate: Mon May 9 12:03:10 2022 +0000
Docs sync done from apache/pulsar(#0975cdc)
---
site2/docs/deploy-bare-metal.md | 2 +-
site2/docs/developing-binary-protocol.md | 19 ++++++++++++++++++-
site2/docs/functions-package.md | 7 +++++--
site2/docs/io-develop.md | 2 ++
site2/website-next/docs/deploy-bare-metal.md | 3 +--
.../website-next/docs/developing-binary-protocol.md | 21 ++++++++++++++++++++-
site2/website-next/docs/functions-package.md | 9 +++++++--
site2/website-next/docs/io-develop.md | 2 ++
.../developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../version-2.1.1-incubating/io-develop.md | 2 ++
.../versioned_docs/version-2.2.0/io-develop.md | 2 ++
.../version-2.2.1/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../versioned_docs/version-2.2.1/io-develop.md | 2 ++
.../version-2.3.0/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../versioned_docs/version-2.3.0/io-develop.md | 2 ++
.../version-2.3.1/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../version-2.3.2/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../versioned_docs/version-2.3.2/io-develop.md | 2 ++
.../versioned_docs/version-2.4.0/io-develop.md | 2 ++
.../version-2.4.1/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../version-2.4.2/developing-binary-protocol.md | 21 ++++++++++++++++++++-
.../version-2.5.0/developing-binary-protocol.md | 21 ++++++++++++++++++++-
22 files changed, 228 insertions(+), 17 deletions(-)
diff --git a/site2/docs/deploy-bare-metal.md b/site2/docs/deploy-bare-metal.md
index 6d12f2dfae5..821f1b80feb 100644
--- a/site2/docs/deploy-bare-metal.md
+++ b/site2/docs/deploy-bare-metal.md
@@ -40,7 +40,7 @@ To run Pulsar on bare metal, the following configuration is recommended:
> * Broker is only supported on 64-bit JVM.
> * If you do not have enough machines, or you want to test Pulsar in cluster mode (and expand the cluster later), You can fully deploy Pulsar on a node on which ZooKeeper, bookie and broker run.
> * If you do not have a DNS server, you can use the multi-host format in the service URL instead.
-Each machine in your cluster needs to have [Java 8](https://adoptium.net/?variant=openjdk8), [Java 11](https://adoptium.net/?variant=openjdk11) or [Java 17](https://adoptium.net/?variant=openjdk17) installed.
+> * Each machine in your cluster needs to have the recommended Java version installed (e.g. [Java 17](https://adoptium.net/?variant=openjdk17)). Please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
The following is a diagram showing the basic setup:
diff --git a/site2/docs/developing-binary-protocol.md b/site2/docs/developing-binary-protocol.md
index 482dcc804a6..8ad4bd388da 100644
--- a/site2/docs/developing-binary-protocol.md
+++ b/site2/docs/developing-binary-protocol.md
@@ -418,7 +418,24 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+```
##### Command CloseConsumer
diff --git a/site2/docs/functions-package.md b/site2/docs/functions-package.md
index 6158eba2ed4..dbbeffa6e6c 100644
--- a/site2/docs/functions-package.md
+++ b/site2/docs/functions-package.md
@@ -17,6 +17,10 @@ To check whether the Docker image starts, you can use the `docker ps` command.
## Java
+> **Note**
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
+
To package a function in Java, complete the following steps.
1. Create a new maven project with a pom file. In the following code sample, the value of `mainClass` is your package name.
@@ -69,8 +73,7 @@ To package a function in Java, complete the following steps.
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
- <source>8</source>
- <target>8</target>
+ <release>17</release>
</configuration>
</plugin>
</plugins>
diff --git a/site2/docs/io-develop.md b/site2/docs/io-develop.md
index 3c5af1873b1..4dff809e2b5 100644
--- a/site2/docs/io-develop.md
+++ b/site2/docs/io-develop.md
@@ -261,6 +261,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/docs/deploy-bare-metal.md b/site2/website-next/docs/deploy-bare-metal.md
index df338e8c3c9..974e1c1dc54 100644
--- a/site2/website-next/docs/deploy-bare-metal.md
+++ b/site2/website-next/docs/deploy-bare-metal.md
@@ -43,11 +43,10 @@ To run Pulsar on bare metal, the following configuration is recommended:
* Broker is only supported on 64-bit JVM.
* If you do not have enough machines, or you want to test Pulsar in cluster mode (and expand the cluster later), You can fully deploy Pulsar on a node on which ZooKeeper, bookie and broker run.
* If you do not have a DNS server, you can use the multi-host format in the service URL instead.
+* Each machine in your cluster needs to have the recommended Java version installed (e.g. [Java 17](https://adoptium.net/?variant=openjdk17)). Please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
:::
-Each machine in your cluster needs to have [Java 8](https://adoptium.net/?variant=openjdk8), [Java 11](https://adoptium.net/?variant=openjdk11) or [Java 17](https://adoptium.net/?variant=openjdk17) installed.
-
The following is a diagram showing the basic setup:
diff --git a/site2/website-next/docs/developing-binary-protocol.md b/site2/website-next/docs/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/docs/developing-binary-protocol.md
+++ b/site2/website-next/docs/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/docs/functions-package.md b/site2/website-next/docs/functions-package.md
index a75b913697e..79ce8b6ac2f 100644
--- a/site2/website-next/docs/functions-package.md
+++ b/site2/website-next/docs/functions-package.md
@@ -20,6 +20,12 @@ To check whether the Docker image starts, you can use the `docker ps` command.
## Java
+:::note
+
+For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
+
+:::
+
To package a function in Java, complete the following steps.
1. Create a new maven project with a pom file. In the following code sample, the value of `mainClass` is your package name.
@@ -73,8 +79,7 @@ To package a function in Java, complete the following steps.
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
- <source>8</source>
- <target>8</target>
+ <release>17</release>
</configuration>
</plugin>
</plugins>
diff --git a/site2/website-next/docs/io-develop.md b/site2/website-next/docs/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/docs/io-develop.md
+++ b/site2/website-next/docs/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.1.1-incubating/io-develop.md b/site2/website-next/versioned_docs/version-2.1.1-incubating/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.1.1-incubating/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.1.1-incubating/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.2.0/io-develop.md b/site2/website-next/versioned_docs/version-2.2.0/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.2.0/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.2.0/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.2.1/io-develop.md b/site2/website-next/versioned_docs/version-2.2.1/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.2.1/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.2.1/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.3.0/io-develop.md b/site2/website-next/versioned_docs/version-2.3.0/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.3.0/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.3.0/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.3.2/io-develop.md b/site2/website-next/versioned_docs/version-2.3.2/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.3.2/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.3.2/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.4.0/io-develop.md b/site2/website-next/versioned_docs/version-2.4.0/io-develop.md
index 7465c9192ec..69c9a2f42c4 100644
--- a/site2/website-next/versioned_docs/version-2.4.0/io-develop.md
+++ b/site2/website-next/versioned_docs/version-2.4.0/io-develop.md
@@ -291,6 +291,8 @@ all libraries your code uses and to your distribution.
> If you use the [NAR](#nar) method, the NAR plugin
automatically creates a `DEPENDENCIES` file in the generated NAR package, including the proper
licensing and copyrights of all libraries of your connector.
+>
+> For the runtime Java version, please refer to [Pulsar Runtime Java Version Recommendation](https://github.com/apache/pulsar/blob/master/README.md#pulsar-runtime-java-version-recommendation) according to your target Pulsar version.
### NAR
diff --git a/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer
diff --git a/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md b/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
index c28723ed27b..fb4f1e92204 100644
--- a/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
+++ b/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
@@ -435,7 +435,26 @@ Parameters:
* `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 AckResponse
+
+An `AckResponse` is the broker’s response to acknowledge a request sent by the client. It contains the `consumer_id` sent in the request.
+If a transaction is used, it contains both Transaction ID and Request ID that are sent in the request.
+The client finishes the specific request according to the Request ID.
+If the `error` field is set, it indicates that the request has failed.
+
+Example of ack response with redirection:
+
+```protobuf
+
+message CommandAckResponse {
+ "consumer_id" : 1,
+ "txnid_least_bits" = 0,
+ "txnid_most_bits" = 1,
+ "request_id" = 5
+}
+
+```
##### Command CloseConsumer