Skip to content

Commit 5d18602

Browse files
committed
add more doc for JOB_ID
1 parent ecd7377 commit 5d18602

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/src/vtr/server_mode/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The telegram header contains helper information required to properly extract the
3737
- 0 - command id for **get critical path**
3838
- 1 - command id for **highlight selected path elements**
3939

40-
JOB_ID - is unique id for a task.
40+
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.
4141

4242
.. note:: The telegram body itself could be compressed with zlib to minimize the amount of data transferred over the socket.
4343
This compression is applied to the response of the 'get critical path report' request.

0 commit comments

Comments
 (0)