Changeset 48879 in vbox for trunk/src/VBox/Main/idl

Timestamp:

Oct 4, 2013 8:37:50 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

89551

Message:

Main/MediumAttachment+Machine: stub attribute/method for an explicit hot-pluggable medium attachment flag, to be used by AHCI soon

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (5 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -4122 +4122 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="7108c7c7-2c0a-47ee-9c69-022fe2a466bf"
+    uuid="480cf695-2d8d-4256-9c7c-cce4184fa048"
     wsmap="managed"
     >
@@ -5564 +5564 @@
     </method>
 
+    <method name="setHotPluggableForDevice">
+      <desc>
+        Sets a flag in the device information which indicates that the attached
+        device is hot pluggable or not. This may or may not be supported by a
+        particular controller and/or drive, and is silently ignored in the
+        latter case. Changing the setting while the VM is running is forbidden.
+        The device must already exist; see <link to="IMachine::attachDevice"/>
+        for how to attach a new device.
+
+        The @a controllerPort and @a device parameters specify the device slot and
+        have have the same meaning as with <link to="IMachine::attachDevice" />.
+
+        <result name="E_INVALIDARG">
+          SATA device, SATA port, IDE port or IDE slot out of range.
+        </result>
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Attempt to modify an unregistered virtual machine.
+        </result>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Invalid machine state.
+        </result>
+        <result name="VBOX_E_NOT_SUPPORTED">
+          Controller doesn't support hot plugging.
+        </result>
+      </desc>
+
+      <param name="name" type="wstring" dir="in">
+        <desc>Name of the storage controller.</desc>
+      </param>
+      <param name="controllerPort" type="long" dir="in">
+        <desc>Storage controller port.</desc>
+      </param>
+      <param name="device" type="long" dir="in">
+        <desc>Device slot in the given port.</desc>
+      </param>
+      <param name="hotPluggable" type="boolean" dir="in">
+        <desc>New value for the hot-pluggable device flag.</desc>
+      </param>
+    </method>
+
     <method name="setBandwidthGroupForDevice">
       <desc>
@@ -5629 +5669 @@
 
     <method name="unmountMedium">
-          <desc>
-            Unmounts any currently mounted medium (<link to="IMedium" />,
-            identified by the given UUID @a id) to the given storage controller
-            (<link to="IStorageController" />, identified by @a name),
-            at the indicated port and device. The device must already exist;
-
-            This method is intended only for managing removable media, where the
-            device is fixed but media is changeable at runtime (such as DVDs
-            and floppies). It cannot be used for fixed media such as hard disks.
-
-            The @a controllerPort and @a device parameters specify the device slot
-            and have have the same meaning as with
-            <link to="IMachine::attachDevice" />.
-
-            The specified device slot must have a medium mounted, which will be
-            unmounted. If there is no mounted medium it will do nothing.
-            See <link to="IMedium"/> for more detailed information about
-            attaching/unmounting media.
-
-            <result name="E_INVALIDARG">
-            SATA device, SATA port, IDE port or IDE slot out of range.
-            </result>
-            <result name="VBOX_E_INVALID_OBJECT_STATE">
-            Attempt to unmount medium that is not removable - not DVD or floppy.
-            </result>
-            <result name="VBOX_E_INVALID_VM_STATE">
-            Invalid machine state.
-            </result>
-            <result name="VBOX_E_OBJECT_IN_USE">
-            Medium already attached to this or another virtual machine.
-            </result>
-            <result name="VBOX_E_OBJECT_NOT_FOUND">
-            Medium not attached to specified port, device, controller.
-            </result>
-
-            </desc>
-              <param name="name" type="wstring" dir="in">
-              <desc>Name of the storage controller to unmount the medium from.</desc>
-              </param>
-              <param name="controllerPort" type="long" dir="in">
-              <desc>Port to unmount the medium from.</desc>
-              </param>
-              <param name="device" type="long" dir="in">
-              <desc>Device slot in the given port to unmount the medium from.</desc>
-              </param>
-              <param name="force" type="boolean" dir="in">
-              <desc>Allows to force unmount of a medium which is locked by
-              the device slot in the given port medium is attached to.</desc>
-              </param>
-          </method>
+      <desc>
+        Unmounts any currently mounted medium (<link to="IMedium" />,
+        identified by the given UUID @a id) to the given storage controller
+        (<link to="IStorageController" />, identified by @a name),
+        at the indicated port and device. The device must already exist;
+
+        This method is intended only for managing removable media, where the
+        device is fixed but media is changeable at runtime (such as DVDs
+        and floppies). It cannot be used for fixed media such as hard disks.
+
+        The @a controllerPort and @a device parameters specify the device slot
+        and have have the same meaning as with
+        <link to="IMachine::attachDevice" />.
+
+        The specified device slot must have a medium mounted, which will be
+        unmounted. If there is no mounted medium it will do nothing.
+        See <link to="IMedium"/> for more detailed information about
+        attaching/unmounting media.
+
+        <result name="E_INVALIDARG">
+          SATA device, SATA port, IDE port or IDE slot out of range.
+        </result>
+        <result name="VBOX_E_INVALID_OBJECT_STATE">
+          Attempt to unmount medium that is not removable - not DVD or floppy.
+        </result>
+        <result name="VBOX_E_INVALID_VM_STATE">
+          Invalid machine state.
+        </result>
+        <result name="VBOX_E_OBJECT_IN_USE">
+          Medium already attached to this or another virtual machine.
+        </result>
+        <result name="VBOX_E_OBJECT_NOT_FOUND">
+          Medium not attached to specified port, device, controller.
+        </result>
+      </desc>
+
+      <param name="name" type="wstring" dir="in">
+        <desc>Name of the storage controller to unmount the medium from.</desc>
+      </param>
+      <param name="controllerPort" type="long" dir="in">
+        <desc>Port to unmount the medium from.</desc>
+      </param>
+      <param name="device" type="long" dir="in">
+        <desc>Device slot in the given port to unmount the medium from.</desc>
+      </param>
+      <param name="force" type="boolean" dir="in">
+        <desc>Allows to force unmount of a medium which is locked by
+        the device slot in the given port medium is attached to.</desc>
+      </param>
+    </method>
 
     <method name="mountMedium">
@@ -12854 +12894 @@
   <interface
     name="IMediumAttachment" extends="$unknown"
-    uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
+    uuid="4b252567-5d4e-4db8-b3c8-569ec1c9236c"
     wsmap="struct"
     >
@@ -13082 +13122 @@
     <attribute name="discard" type="boolean" readonly="yes">
       <desc>Whether the associated medium supports discarding unused blocks.</desc>
+    </attribute>
+
+    <attribute name="hotPluggable" type="boolean" readonly="yes">
+      <desc>Whether this attachment is hot pluggable or not.</desc>
     </attribute>