You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2022/05/24 02:07:29 UTC
[pulsar] branch master updated: [fix][doc] Binary protocol spec: perform topic lookup before creating/connecting a producer/consumer (#15714)
This is an automated email from the ASF dual-hosted git repository.
liuyu 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 006eb99c4dd [fix][doc] Binary protocol spec: perform topic lookup before creating/connecting a producer/consumer (#15714)
006eb99c4dd is described below
commit 006eb99c4ddc4771c9a8634c3e9626a92da11f0f
Author: momo-jun <60...@users.noreply.github.com>
AuthorDate: Tue May 24 10:07:22 2022 +0800
[fix][doc] Binary protocol spec: perform topic lookup before creating/connecting a producer/consumer (#15714)
---
site2/docs/develop-binary-protocol.md | 8 ++++++++
site2/docs/developing-binary-protocol.md | 14 +++++++++++++-
2 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/site2/docs/develop-binary-protocol.md b/site2/docs/develop-binary-protocol.md
index 63e43dda525..ce72beacf70 100644
--- a/site2/docs/develop-binary-protocol.md
+++ b/site2/docs/develop-binary-protocol.md
@@ -4,6 +4,14 @@ title: Pulsar binary protocol specification
sidebar_label: "Binary protocol"
---
+:::note
+
+**Important**
+
+This page is deprecated and not updated anymore. For the latest and complete information, see [Pulsar binary protocol specification](developing-binary-protocol.md).
+
+:::
+
Pulsar uses a custom binary protocol for communications between producers/consumers and brokers. This protocol is designed to support required features, such as acknowledgements and flow control, while ensuring maximum transport and implementation efficiency.
Clients and brokers exchange *commands* with each other. Commands are formatted as binary [protocol buffer](https://developers.google.com/protocol-buffers/) (aka *protobuf*) messages. The format of protobuf commands is specified in the [`PulsarApi.proto`](https://github.com/apache/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto) file and also documented in the [Protobuf interface](#protobuf-interface) section below.
diff --git a/site2/docs/developing-binary-protocol.md b/site2/docs/developing-binary-protocol.md
index 2c228f623dc..d571e976b21 100644
--- a/site2/docs/developing-binary-protocol.md
+++ b/site2/docs/developing-binary-protocol.md
@@ -191,6 +191,12 @@ If the client does not receive a response indicating producer creation success o
the client should first send a command to close the original producer before sending a
command to re-attempt producer creation.
+:::note
+
+Before creating or connecting a producer, you need to perform [topic lookup](#topic-lookup) first.
+
+:::
+
##### Command Producer
```protobuf
@@ -284,7 +290,7 @@ Fields:
* `sequence_id`: The sequence ID of the published message.
* `message_id`: The message ID assigned by the system to the published message
Unique within a single cluster. Message ID is composed of 2 longs, `ledgerId`
- and `entryId`, that reflect that this unique ID is assigned when appending
+ and `entryId`, which reflects that this unique ID is assigned when appending
to a BookKeeper ledger.
@@ -321,6 +327,12 @@ subscription is not already there, a new one will be created.
+:::note
+
+Before creating or connecting a consumer, you need to perform [topic lookup](#topic-lookup) first.
+
+:::
+
#### Flow control
After the consumer is ready, the client needs to *give permission* to the