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 12:47:09 UTC
[GitHub] [pulsar] asafm opened a new pull request, #15878: [fix][doc] Fixed binary protocol naming and descriptions
asafm opened a new pull request, #15878:
URL: https://github.com/apache/pulsar/pull/15878
### Modifications
* Fixed documentation of basic command structure to match the code
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
This change is a trivial rework / code cleanup without any test coverage.
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [ ] `doc-not-needed`
(Please explain why)
- [ ] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
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
[GitHub] [pulsar] github-actions[bot] commented on pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15878:
URL: https://github.com/apache/pulsar/pull/15878#issuecomment-1143602674
@asafm:Thanks for providing doc info!
--
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
[GitHub] [pulsar] codelipenghui commented on a diff in pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
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
[GitHub] [pulsar] asafm commented on pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
asafm commented on PR #15878:
URL: https://github.com/apache/pulsar/pull/15878#issuecomment-1144679151
@codelipenghui Changed
--
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
[GitHub] [pulsar] github-actions[bot] commented on pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15878:
URL: https://github.com/apache/pulsar/pull/15878#issuecomment-1143600356
@asafm:Thanks for your contribution. For this PR, do we need to update docs?
(The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)
--
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
[GitHub] [pulsar] codelipenghui merged pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
codelipenghui merged PR #15878:
URL: https://github.com/apache/pulsar/pull/15878
--
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
[GitHub] [pulsar] asafm commented on a diff in pull request #15878: [fix][doc] Fixed binary protocol naming and descriptions
Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15878:
URL: https://github.com/apache/pulsar/pull/15878#discussion_r887785670
##########
site2/docs/developing-binary-protocol.md:
##########
@@ -28,39 +28,39 @@ 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
+### Message commands
Payload commands have this basic structure:
-| Component | Required or optional| Description | Size (in bytes) |
-|:-----------------------------------|:----------|:--------------------------------------------------------------------------------------------|:----------------|
-| `totalSize` | Required | The size of the frame, counting everything that comes after it (in bytes) | 4 |
-| `commandSize` | Required | The size of the protobuf-serialized command | 4 |
-| `message` | Required | The protobuf message serialized in a raw binary format (rather than in protobuf format) | |
-| `magicNumberOfBrokerEntryMetadata` | Optional | A 2-byte byte array (`0x0e02`) identifying the broker entry metadata <br /> **Note**: `magicNumberOfBrokerEntryMetadata` , `brokerEntryMetadataSize`, and `brokerEntryMetadata` should be used **together**. | 2 |
-| `brokerEntryMetadataSize` | Optional | The size of the broker entry metadata | 4 |
-| `brokerEntryMetadata` | Optional | The broker entry metadata stored as a binary protobuf message | |
-| `magicNumber` | Required | A 2-byte byte array (`0x0e01`) identifying the current format | 2 |
-| `checksum` | Required | A [CRC32-C checksum](http://www.evanjones.ca/crc32c.html) of everything that comes after it | 4 |
-| `metadataSize` | Required | The size of the message [metadata](#message-metadata) | 4 |
-| `metadata` | Required | The message [metadata](#message-metadata) stored as a binary protobuf message | |
-| `payload` | Required | Anything left in the frame is considered the payload and can include any sequence of bytes | |
+| Component | Required or optional | Description | Size (in bytes) |
+|:-----------------------------------|:---------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------|
+| `totalSize` | Required | The size of the frame, counting everything that comes after it (in bytes) | 4 |
+| `commandSize` | Required | The size of the protobuf-serialized command | 4 |
+| `command` | Required | The protobuf serialized command | |
+| `magicNumberOfBrokerEntryMetadata` | Optional | A 2-byte byte array (`0x0e02`) identifying the broker entry metadata <br /> **Note**: `magicNumberOfBrokerEntryMetadata` , `brokerEntryMetadataSize`, and `brokerEntryMetadata` should be used **together**. | 2 |
+| `brokerEntryMetadataSize` | Optional | The size of the broker entry metadata | 4 |
+| `brokerEntryMetadata` | Optional | The broker entry metadata stored as a binary protobuf message | |
+| `magicNumber` | Required | A 2-byte byte array (`0x0e01`) identifying the current format | 2 |
+| `checksum` | Required | A [CRC32-C checksum](http://www.evanjones.ca/crc32c.html) of everything that comes after it | 4 |
+| `metadataSize` | Required | The size of the message [metadata](#message-metadata) | 4 |
+| `metadata` | Required | The message [metadata](#message-metadata) stored as a binary protobuf message | |
+| `payload` | Required | Anything left in the frame is considered the payload and can include any sequence of bytes | |
## Broker entry metadata
Broker entry metadata is stored alongside the message metadata as a serialized protobuf message.
It is created by the broker when the message arrived at the broker and passed without changes to the consumer if configured.
-| Field | Required or optional | Description |
-|:-------------------|:----------------|:------------------------------------------------------------------------------------------------------------------------------|
-| `broker_timestamp` | Optional | The timestamp when a message arrived at the broker (`id est` as the number of milliseconds since January 1st, 1970 in UTC) |
-| `index` | Optional | The index of the message. It is assigned by the broker.
+| Field | Required or optional | Description |
Review Comment:
##########
site2/docs/developing-binary-protocol.md:
##########
@@ -28,39 +28,39 @@ 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) |
Review Comment:
##########
site2/docs/developing-binary-protocol.md:
##########
@@ -28,39 +28,39 @@ 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
+### Message commands
Payload commands have this basic structure:
-| Component | Required or optional| Description | Size (in bytes) |
-|:-----------------------------------|:----------|:--------------------------------------------------------------------------------------------|:----------------|
-| `totalSize` | Required | The size of the frame, counting everything that comes after it (in bytes) | 4 |
-| `commandSize` | Required | The size of the protobuf-serialized command | 4 |
-| `message` | Required | The protobuf message serialized in a raw binary format (rather than in protobuf format) | |
-| `magicNumberOfBrokerEntryMetadata` | Optional | A 2-byte byte array (`0x0e02`) identifying the broker entry metadata <br /> **Note**: `magicNumberOfBrokerEntryMetadata` , `brokerEntryMetadataSize`, and `brokerEntryMetadata` should be used **together**. | 2 |
-| `brokerEntryMetadataSize` | Optional | The size of the broker entry metadata | 4 |
-| `brokerEntryMetadata` | Optional | The broker entry metadata stored as a binary protobuf message | |
-| `magicNumber` | Required | A 2-byte byte array (`0x0e01`) identifying the current format | 2 |
-| `checksum` | Required | A [CRC32-C checksum](http://www.evanjones.ca/crc32c.html) of everything that comes after it | 4 |
-| `metadataSize` | Required | The size of the message [metadata](#message-metadata) | 4 |
-| `metadata` | Required | The message [metadata](#message-metadata) stored as a binary protobuf message | |
-| `payload` | Required | Anything left in the frame is considered the payload and can include any sequence of bytes | |
+| Component | Required or optional | Description | Size (in bytes) |
Review Comment:
--
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