diff options
| author | Eric Blake <eblake@redhat.com> | 2014-07-23 06:26:15 -0600 |
|---|---|---|
| committer | Luiz Capitulino <lcapitulino@redhat.com> | 2014-07-24 09:59:20 -0400 |
| commit | f8ecd94501e43d82de2e6102f5fe4de042cbe3ca (patch) | |
| tree | 23e17be232f72c03f351b6c4f8139ecb6b14b91e /docs/qmp | |
| parent | 1454ac68af227145d2c336a3b55161cb785e32c4 (diff) | |
docs: split SPICE_* event docs
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>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Wenchao Xia <wenchaoqemu@gmail.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Diffstat (limited to 'docs/qmp')
| -rw-r--r-- | docs/qmp/qmp-events.txt | 31 |
1 files changed, 28 insertions, 3 deletions
diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt index 524eadf1d5..9b7ee7c5b7 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 ----------------- |