Skip to content

Commit 4f28a00

Browse files
committed
server_mode/index.rst, describe more about COMPRESSOR_ID and CHECKSUM fields
1 parent c27edfb commit 4f28a00

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

doc/src/vtr/server_mode/index.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,14 @@ The telegram header contains helper information required to properly extract the
2323

2424
Communication telegram structure.
2525

26-
26+
.. note:: The telegram body itself could be compressed with zlib to minimize the amount of data transferred over the socket.
27+
This compression is applied to the response of the 'get critical path report' request. The compressor ID byte in the telegram header signals whether the telegram body is compressed.
28+
When the compressor ID is null, the telegram body is not compressed. If the compressor ID is 'z', it means the body is compressed with zlib.
29+
30+
.. note:: The checksum field contains the telegram body checksum. This checksum is used to validate the consistency of the telegram body during the dispatching phase.
31+
If checksums are mismatched, the telegram is considered invalid and is skipped in processing.
32+
33+
2734
.. _fig_comm_telegram_body_structure:
2835

2936
.. figure:: comm_telegram_body_structure.*
@@ -39,9 +46,6 @@ The telegram header contains helper information required to properly extract the
3946

4047
JOB_ID is a unique ID for a task. It is used to associate the request with the response by matching the same JOB_ID. Each new client request should increment the JOB_ID value; otherwise, it will not be clear which request the current response belongs to.
4148

42-
.. note:: The telegram body itself could be compressed with zlib to minimize the amount of data transferred over the socket.
43-
This compression is applied to the response of the 'get critical path report' request.
44-
The compressor ID byte in the telegram header signals whether the telegram body is compressed.
4549

4650
Get critical path timing report example
4751
---------------------------------------

0 commit comments

Comments
 (0)