You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/06/01 15:15:53 UTC

[GitHub] [pulsar] codelipenghui commented on a diff in pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions

codelipenghui commented on code in PR #15878:
URL: https://github.com/apache/pulsar/pull/15878#discussion_r886930870


##########
site2/docs/develop-binary-protocol.md:
##########
@@ -36,29 +36,29 @@ The Pulsar protocol allows for two types of commands:
 
 Simple (payload-free) commands have this basic structure:
 
-| Component     | Description                                                                             | Size (in bytes) |
-|:--------------|:----------------------------------------------------------------------------------------|:----------------|
-| `totalSize`   | The size of the frame, counting everything that comes after it (in bytes)               | 4               |
-| `commandSize` | The size of the protobuf-serialized command                                             | 4               |
-| `message`     | The protobuf message serialized in a raw binary format (rather than in protobuf format) |                 |
+| Component     | Description                                                               | Size (in bytes) |
+|:--------------|:--------------------------------------------------------------------------|:----------------|
+| `totalSize`   | The size of the frame, counting everything that comes after it (in bytes) | 4               |
+| `commandSize` | The size of the protobuf-serialized command                               | 4               |
+| `command`     | The protobuf serialized command                                           |                 |  
 
 ### Payload commands

Review Comment:
   I think we'd better change here to `Message commands`
   
   The Message command contains the `protobuf command + message metadata + user's payload`
   I think it's easier to understand what is the message, what is the payload.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org