Skip to contentSkip to conversation

docs/interop/qmp-spec: Document the request queue limit

PATCH In review Markus Armbruster 2 participants 3 messages Jan 27, 2021 – Feb 2, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/interop/qmp-spec: Document the request queue limit

---
 docs/interop/qmp-spec.txt | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
docs/interop/qmp-spec.txt +5 -3
index cdf5842555..b0e8351d5b 100644
@@ -133,9 +133,11 @@ to pass "id" with out-of-band commands.  Passing it with all commands
 is recommended for clients that accept capability "oob".
 
 If the client sends in-band commands faster than the server can
-execute them, the server will stop reading the requests from the QMP
-channel until the request queue length is reduced to an acceptable
-range.
+execute them, the server will stop reading requests until the request
+queue length is reduced to an acceptable range.
+
+To ensure commands to be executed out-of-band get read and executed,
+the client should have at most eight in-band commands in flight.
 
 Only a few commands support out-of-band execution.  The ones that do
 have "allow-oob": true in output of query-qmp-schema.
Signature · 1 line
2.26.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 15 lines · Markus Armbruster
---
  docs/interop/qmp-spec.txt | 8 +++++---
  1 file changed, 5 insertions(+), 3 deletions(-)
docs/interop/qmp-spec.txt +0 -1
index cdf5842555..b0e8351d5b 100644
@@ -133,9 +133,11 @@ to pass "id" with out-of-band commands.  Passing it with all commands
  is recommended for clients that accept capability "oob".
 
  If the client sends in-band commands faster than the server can
-execute them, the server will stop reading the requests from the QMP

docs/interop/qmp-spec.txt to pass "id" with out-of-band commands. Passing it with all commands · line 143

Quoted 10 lines
docs/interop/qmp-spec.txt +5 -2
-channel until the request queue length is reduced to an acceptable
-range.
+execute them, the server will stop reading requests until the request
+queue length is reduced to an acceptable range.
+
+To ensure commands to be executed out-of-band get read and executed,
+the client should have at most eight in-band commands in flight.
 
  Only a few commands support out-of-band execution.  The ones that do
  have "allow-oob": true in output of query-qmp-schema.

Great to know, thank you!