[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v4 18/23] QMP: Reserve namespace for complex object
From: |
Jan Kiszka |
Subject: |
[Qemu-devel] [PATCH v4 18/23] QMP: Reserve namespace for complex object classes |
Date: |
Wed, 16 Jun 2010 00:38:42 +0200 |
From: Jan Kiszka <address@hidden>
This reserves JSON objects that contain the key '__class__' for QMP-specific
complex objects. First user will be the buffer class.
Signed-off-by: Jan Kiszka <address@hidden>
---
QMP/qmp-spec.txt | 16 +++++++++++++---
1 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/QMP/qmp-spec.txt b/QMP/qmp-spec.txt
index 9d30a8c..fa1dd62 100644
--- a/QMP/qmp-spec.txt
+++ b/QMP/qmp-spec.txt
@@ -146,6 +146,15 @@ The format is:
For a listing of supported asynchronous events, please, refer to the
qmp-events.txt file.
+2.6 Complex object classes
+--------------------------
+
+JSON objects that contain the key-value pair '"__class__": json-string' are
+reserved for QMP-specific complex object classes that. QMP specifies which
+further keys each of these objects include and how they are encoded.
+
+So far, no complex object class is specified.
+
3. QMP Examples
===============
@@ -229,9 +238,10 @@ avoid modifying QMP. Both upstream and downstream need to
take care to
preserve long-term compatibility and interoperability.
To help with that, QMP reserves JSON object member names beginning with
-'__' (double underscore) for downstream use ("downstream names"). This
-means upstream will never use any downstream names for its commands,
-arguments, errors, asynchronous events, and so forth.
+'__' (double underscore) for downstream use ("downstream names"). Downstream
+names MUST NOT end with '__' as this pattern is reserved for QMP-defined JSON
+object classes. Upstream will never use any downstream names for its
+commands, arguments, errors, asynchronous events, and so forth.
Any new names downstream wishes to add must begin with '__'. To
ensure compatibility with other downstreams, it is strongly
--
1.6.0.2
- [Qemu-devel] [PATCH] monitor: Allow to exclude commands from QMP, (continued)
- [Qemu-devel] [PATCH v4 15/23] monitor: Establish cmd flags and convert the async tag, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 16/23] monitor: Allow to exclude commands from QMP, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 14/23] monitor: return length of printed string via monitor_[v]printf, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 17/23] Add base64 encoder/decoder, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 21/23] QMP: Teach basic capability negotiation to python example, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 12/23] monitor: Add completion for qdev paths, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 19/23] QMP: Add QBuffer, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 18/23] QMP: Reserve namespace for complex object classes,
Jan Kiszka <=
- [Qemu-devel] [PATCH v4 22/23] QMP: Fix python helper /wrt long return strings, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 23/23] QMP: Add support for buffer class to qmp python helper, Jan Kiszka, 2010/06/15
- [Qemu-devel] [PATCH v4 20/23] monitor: Add basic device state visualization, Jan Kiszka, 2010/06/15
- Re: [Qemu-devel] [PATCH v4 00/23] qdev path reworks & basic device state visualization, Markus Armbruster, 2010/06/23