Skip to content

Commit af9541e

Browse files
committed
enhance telegramheader field [ 1 byte ]: COMPRESSOR_ID description
1 parent 69e734e commit af9541e

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

vpr/src/server/telegramheader.h

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ namespace comm {
1818
* - [ 4 bytes ]: SIGNATURE - A 4-byte constant sequence "I", "P", "A", "\0" which indicates the valid start of a TelegramHeader.
1919
* - [ 4 bytes ]: DATA_LENGTH - A 4-byte field where the data length is stored, allowing for proper identification of the start and end of the TelegramFrame sequence.
2020
* - [ 4 bytes ]: DATA_CHECKSUM - A 4-byte field where the data checksum is stored to validate the attached data.
21-
* - [ 1 byte ]: COMPRESSOR_ID - A 1-byte field where the compressor id is stored. If it's \0, it means the data is not compressed (in text/json format).
22-
*
23-
* @note: Currently, only zlib compression for the telegram body is supported, which is specified with COMPRESSOR_ID='z'.
21+
* - [ 1 byte ]: COMPRESSOR_ID - A 1-byte field where the compressor ID is stored. If it's null, it means the telegram body is not compressed (in text/json format).
22+
* Otherwise, the telegram body is compressed. Currently, only zlib compression for the telegram body is supported, which is specified with COMPRESSOR_ID='z'.
2423
*
2524
* @note: The DATA_CHECKSUM field can be used to check the integrity of the telegram body on the client app side.
2625
*/

0 commit comments

Comments
 (0)