Changeset 78148 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Apr 16, 2019 4:48:18 PM (6 years ago)

Author:

vboxsync

Message:

OCI: Change ICloudClient::listImages and listInstances signatures to
return a progress. Since we cannot asynchronously update by-value
string arrays, introduce a wrapper IStringArray interface and use it.
Adapt VBoxManage to that API change.

Ifdef out the single use of listInstances in GUI. Ok dsen, he will
adapt the GUI code.

Since extpack cannot directly use code from Main and since
IStringArray implementation is really trivial, just do one in the
extpack at least for now so that this change is not bogged down in
technicalities.

The actual implementation of list methods is still synchronous and
just returns completed progress at the end. It will be made
asynchronous in a separate commit.

File:

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

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

@@ -25537 +25537 @@
 
   <!--
+  // Auxiliary containers
+  //////////////////////////////////////////////////////////////////////////
+  -->
+
+  <interface name="IStringArray" extends="$unknown"
+             uuid="3890b2c8-604d-11e9-92d3-53cb473db9fb"
+             wsmap="managed"
+             reservedMethods="4">
+    <desc>
+      When you need to return an array of strings asynchronously
+      (under a progress) you cannot use by-value out parameter
+      <tt>type=&quot;wstring&quot; safearray=&quot;yes&quot;
+      dir=&quot;out&quot;</tt>, hence this wrapper.
+    </desc>
+    <attribute name="values" type="wstring" safearray="yes" readonly="yes"/>
+  </interface>
+
+
+  <!--
   // IForm
   //////////////////////////////////////////////////////////////////////////
@@ -25684 +25703 @@
   <interface
     name="ICloudClient" extends="$unknown"
-    uuid="07c04464-981c-4418-8fcf-5ad12aed7c38"
+    uuid="7acc426a-5f8f-11e9-9032-1b0da54759a8"
     wsmap="managed" reservedMethods="13" reservedAttributes="8"
     >
@@ -25736 +25755 @@
       </desc>
       <param name="machineState" type="CloudMachineState" dir="in"/>
-      <param name="returnNames" type="wstring" safearray="yes" dir="out">
+      <param name="returnNames" type="IStringArray" dir="out">
         <desc>VM names.</desc>
       </param>
-      <param name="returnIds" type="wstring" safearray="yes" dir="return">
+      <param name="returnIds" type="IStringArray" dir="out">
         <desc>VM ids.</desc>
       </param>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>
+          Progress object to track the operation completion.
+        </desc>
+      </param>
     </method>
 
@@ -25749 +25773 @@
       </desc>
       <param name="imageState" type="CloudImageState" dir="in"/>
-      <param name="returnNames" type="wstring" safearray="yes" dir="out">
+      <param name="returnNames" type="IStringArray" dir="out">
         <desc>Images names.</desc>
       </param>
-      <param name="returnIds" type="wstring" safearray="yes" dir="return">
+      <param name="returnIds" type="IStringArray" dir="out">
         <desc>Images ids.</desc>
+      </param>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>
+          Progress object to track the operation completion.
+        </desc>
       </param>
     </method>