From 781386afd2b809a8a63b65e9bfb645c4a8abdf50 Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Wed, 27 Jan 2021 15:47:34 +0100 Subject: [PATCH] docs/interop/qmp-spec: Document the request queue limit Signed-off-by: Markus Armbruster Message-Id: <20210127144734.2367693-1-armbru@redhat.com> Reviewed-by: John Snow --- docs/interop/qmp-spec.txt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/interop/qmp-spec.txt b/docs/interop/qmp-spec.txt index cdf5842555..b0e8351d5b 100644 --- a/docs/interop/qmp-spec.txt +++ b/docs/interop/qmp-spec.txt @@ -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.