Skip to content

Commit 69e734e

Browse files
committed
extend telegramheader doc with adding nore for DATA_CHECKSUM and COMPRESSOR_ID fields
1 parent b454ee9 commit 69e734e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

vpr/src/server/telegramheader.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ namespace comm {
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.
2121
* - [ 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'.
24+
*
25+
* @note: The DATA_CHECKSUM field can be used to check the integrity of the telegram body on the client app side.
2226
*/
2327
class TelegramHeader {
2428
public:

0 commit comments

Comments
 (0)