diff options
| author | Luiz Capitulino <lcapitulino@redhat.com> | 2012-05-08 14:24:48 -0300 |
|---|---|---|
| committer | Michael Roth <mdroth@linux.vnet.ibm.com> | 2012-05-15 09:15:16 -0500 |
| commit | 432d29db0db9d08fe34a57b8c03af20c9f759d77 (patch) | |
| tree | cddff91567de08eb6371400be5fecdfeb3428371 /qapi-schema-guest.json | |
| parent | c6fcc10ab31d22e93eb169c451025ac9636ec84b (diff) | |
qemu-ga: guest-suspend-ram: don't emit a success response
Today, qemu-ga may not be able to emit a success response when
guest-suspend-ram completes. This happens because the VM may
suspend before qemu-ga is able to emit a response.
This semantic is a bit confusing, as it's not clear for clients if
they should wait for a response or how they should check for success.
This commit solves that problem by changing guest-suspend-ram to
never emit a success response and suggests in the documentation
what clients should do to check for success.
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Michael Roth <mdroth@linux.vnet.ibm.com>
Diffstat (limited to 'qapi-schema-guest.json')
| -rw-r--r-- | qapi-schema-guest.json | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/qapi-schema-guest.json b/qapi-schema-guest.json index 88b165cac0..50e2815fb1 100644 --- a/qapi-schema-guest.json +++ b/qapi-schema-guest.json @@ -395,17 +395,21 @@ # command. Thus, it's *required* to query QEMU for the presence of the # 'system_wakeup' command before issuing guest-suspend-ram. # -# Returns: nothing on success +# This command does NOT return a response on success. There are two options +# to check for success: +# 1. Wait for the SUSPEND QMP event from QEMU +# 2. Issue the query-status QMP command to confirm the VM status is +# "suspended" +# +# The following errors may be returned: # If suspend to ram is not supported, Unsupported # -# Notes: o This is an asynchronous request. There's no guarantee a response -# will be sent -# o It's strongly recommended to issue the guest-sync command before -# sending commands when the guest resumes +# Notes: It's strongly recommended to issue the guest-sync command before +# sending commands when the guest resumes # # Since: 1.1 ## -{ 'command': 'guest-suspend-ram' } +{ 'command': 'guest-suspend-ram', 'success-response': 'no' } ## # @guest-suspend-hybrid |