docs/interop/qmp-spec.rst

5     later. See the COPYING file in the top-level directory.
14 machine-level.  It is also in use by the QEMU Guest Agent (QGA), which
18 be found in the :doc:`qemu-qmp-ref` and the :doc:`qemu-ga-ref`.
29 JSON data structures, when mentioned in this document, are always in the
37 The server expects its input to be encoded in UTF-8, and sends its
38 output encoded in ASCII.
40 For convenience, json-object members mentioned in this document will
41 be in a certain order. However, in real protocol usage they can be in
48 ``'single-quoted'`` strings in place of the usual ``"double-quoted"``
80   baseline specification; the order of elements in this array has no
90   execution, as described in section `Out-of-band execution`_.
120 The actual commands are documented in the :doc:`qemu-qmp-ref`.
126 the other.  The client therefore receives command responses in issue
133 possibly overtaking prior in-band commands.  The client may therefore
134 receive such a command's response before responses from prior in-band
141 If the client sends in-band commands faster than the server can
146 the client should have at most eight in-band commands in flight.
149 have ``"allow-oob": true`` in the output of ``query-qmp-schema``.
158 same ``id`` field will be attached in the corresponding response message
199 in these cases the ``id`` member will not be part of the error response, even
206 to the Client at any time, when not in the middle of any other
219 - The ``data`` member contains event specific data, which is defined in a
222   occurred in the Server. It is a fixed json-object with time in
227 The actual asynchronous events are documented in the :doc:`qemu-qmp-ref`.
237 Incomplete or invalid input can leave the server's JSON parser in a
264 This section provides some examples of real QMP usage, in all of them
336 When a Client successfully establishes a connection, the Server is in
344 advertised in the `Server Greeting`_ which they support.
354 All protocol changes or new features which modify the protocol format in an
356 capabilities array (in the `Server Greeting`_). Thus, Clients can check
370 - Size of json-objects; in particular, future versions of QEMU may add
374   to any existing command in newer versions of the Server
377 and may be withdrawn or changed in an incompatible manner in a future
381 this, a Client should be "conservative in what they send, and liberal in
423 properly ignores any downstream members in the output it receives.
434 3. Introducing new errors for use in new commands is okay.  Adding new