Merge tag 'pull-la-20220808' of https://gitlab.com/rth7680/qemu into staging
[qemu.git] / backends / dbus-vmstate1.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
3 <!--
4 org.qemu.VMState1:
5
6 This interface must be implemented at the object path
7 ``/org/qemu/VMState1`` to support helper migration.
8 -->
9 <interface name="org.qemu.VMState1">
10
11 <!--
12 Id:
13
14 A string that identifies the helper uniquely. (maximum 256 bytes
15 including terminating NUL byte)
16
17 .. note::
18
19 The VMState helper ID namespace is its own namespace. In particular,
20 it is not related to QEMU "id" used in -object/-device objects.
21 -->
22 <property name="Id" type="s" access="read"/>
23
24 <!--
25 Load:
26 @data: data to restore the state.
27
28 The method called on destination with the state to restore.
29
30 The helper may be initially started in a waiting state (with an
31 ``-incoming`` argument for example), and it may resume on success.
32
33 An error may be returned to the caller.
34 -->
35 <method name="Load">
36 <arg type="ay" name="data" direction="in"/>
37 </method>
38
39 <!--
40 Save:
41 @data: state data to save for later resume.
42
43 The method called on the source to get the current state to be
44 migrated. The helper should continue to run normally.
45
46 An error may be returned to the caller.
47 -->
48 <method name="Save">
49 <arg type="ay" name="data" direction="out"/>
50 </method>
51 </interface>
52 </node>