From: Eric Blake <eblake@redhat.com>
To: qemu-devel@nongnu.org
Cc: pbonzini@redhat.com, wenchaoqemu@gmail.com, armbru@redhat.com,
lcapitulino@redhat.com
Subject: [Qemu-devel] [PATCH v2 for-2.1 2/5] docs: split SPICE_* event docs
Date: Wed, 23 Jul 2014 06:26:15 -0600 [thread overview]
Message-ID: <1406118378-11217-3-git-send-email-eblake@redhat.com> (raw)
In-Reply-To: <1406118378-11217-1-git-send-email-eblake@redhat.com>
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 <eblake@redhat.com>
---
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
next prev parent reply other threads:[~2014-07-23 12:26 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-23 12:26 [Qemu-devel] [PATCH v2 for-2.1 0/5] docs: document remaining QMP events Eric Blake
2014-07-23 12:26 ` [Qemu-devel] [PATCH v2 for-2.1 1/5] docs: grammar fixes to qmp-events Eric Blake
2014-07-23 12:26 ` Eric Blake [this message]
2014-07-23 12:26 ` [Qemu-devel] [PATCH v2 for-2.1 3/5] docs: document missing SPICE_MIGRATE_COMPLETED event Eric Blake
2014-07-23 13:43 ` Markus Armbruster
2014-07-23 12:26 ` [Qemu-devel] [PATCH v2 for-2.1 4/5] docs: document missing POWERDOWN event Eric Blake
2014-07-23 14:11 ` Wenchao Xia
2014-07-23 12:26 ` [Qemu-devel] [PATCH v2 for-2.1 5/5] docs: document missing VSERPORT_CHANGE event Eric Blake
2014-07-23 13:44 ` [Qemu-devel] [PATCH v2 for-2.1 0/5] docs: document remaining QMP events Markus Armbruster
2014-07-23 14:12 ` Wenchao Xia
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1406118378-11217-3-git-send-email-eblake@redhat.com \
--to=eblake@redhat.com \
--cc=armbru@redhat.com \
--cc=lcapitulino@redhat.com \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=wenchaoqemu@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).