[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs
From: |
Luiz Capitulino |
Subject: |
[Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs |
Date: |
Thu, 24 Jul 2014 10:17:45 -0400 |
From: Eric Blake <address@hidden>
For consistency with the rest of this file, every event should be
listed in isolation. Compare how commit 7cfadb6b split
SPICE_CONNECTED and SPICE_DISCONNECTED into separate qmp events.
* docs/qmp/qmp-events.txt (SPICE_CONNECTED, SPICE_DISCONNECTED):
Split.
Signed-off-by: Eric Blake <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
Reviewed-by: Wenchao Xia <address@hidden>
Signed-off-by: Luiz Capitulino <address@hidden>
---
docs/qmp/qmp-events.txt | 31 ++++++++++++++++++++++++++++---
1 file changed, 28 insertions(+), 3 deletions(-)
diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 524eadf..9b7ee7c 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -337,10 +337,10 @@ Example:
Note: If the command-line option "-no-shutdown" has been specified, a STOP
event will eventually follow the SHUTDOWN event.
-SPICE_CONNECTED, SPICE_DISCONNECTED
------------------------------------
+SPICE_CONNECTED
+---------------
-Emitted when a SPICE client connects or disconnects.
+Emitted when a SPICE client connects.
Data:
@@ -362,6 +362,31 @@ Example:
"client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
}}
+SPICE_DISCONNECTED
+------------------
+
+Emitted when a SPICE client disconnects.
+
+Data:
+
+- "server": Server information (json-object)
+ - "host": IP address (json-string)
+ - "port": port number (json-string)
+ - "family": address family (json-string, "ipv4" or "ipv6")
+- "client": Client information (json-object)
+ - "host": IP address (json-string)
+ - "port": port number (json-string)
+ - "family": address family (json-string, "ipv4" or "ipv6")
+
+Example:
+
+{ "timestamp": {"seconds": 1290688046, "microseconds": 388707},
+ "event": "SPICE_DISCONNECTED",
+ "data": {
+ "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"},
+ "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"}
+}}
+
SPICE_INITIALIZED
-----------------
--
1.9.3
- [Qemu-devel] [PULL for-2.1 0/5] QMP queue, Luiz Capitulino, 2014/07/24
- [Qemu-devel] [PULL 5/5] docs: document missing VSERPORT_CHANGE event, Luiz Capitulino, 2014/07/24
- [Qemu-devel] [PULL 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event, Luiz Capitulino, 2014/07/24
- [Qemu-devel] [PULL 2/5] docs: split SPICE_* event docs,
Luiz Capitulino <=
- [Qemu-devel] [PULL 1/5] docs: grammar fixes to qmp-events, Luiz Capitulino, 2014/07/24
- [Qemu-devel] [PULL 4/5] docs: document missing POWERDOWN event, Luiz Capitulino, 2014/07/24
- Re: [Qemu-devel] [PULL for-2.1 0/5] QMP queue, Peter Maydell, 2014/07/24