Changeset 90440 in vbox

Timestamp:

Jul 30, 2021 8:00:15 PM (4 years ago)

Author:

vboxsync

Message:

Main/VirtualBox: New event for creating/deleting of Progress objects in VBoxSVC. Intentionally not passing an object reference to avoid postponing the actual object progress object destruction. Plus a new method for finding progress objects by GUID (otherwise the event handler would often need client side searching by GUID which is inefficient).

Location:

trunk

Files:

• include/VBox/log.h (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (5 diffs)
• src/VBox/Main/include/VirtualBoxImpl.h (modified) (3 diffs)
• src/VBox/Main/src-server/VirtualBoxImpl.cpp (modified) (4 diffs)

trunk/include/VBox/log.h

@@ -545 +545 @@
     /** Main group, IProgress. */
     LOG_GROUP_MAIN_PROGRESS,
+    /** Main group, IProgressCreatedEvent. */
+    LOG_GROUP_MAIN_PROGRESSCREATEDEVENT,
     /** Main group, IProgressEvent. */
     LOG_GROUP_MAIN_PROGRESSEVENT,

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

@@ -2544 +2544 @@
   <interface
     name="IVirtualBox" extends="$unknown"
-    uuid="d0a0163f-e254-4e5b-a1f2-011cf991c38d"
+    uuid="0efe109d-9b2e-48cf-9969-3fb7b711062e"
     wsmap="managed"
     reservedMethods="8" reservedAttributes="12"
@@ -3562 +3562 @@
       <param name="result" type="boolean" dir="return">
         <desc>If firmware of this type and version is available.</desc>
+      </param>
+    </method>
+
+    <method name="findProgressById">
+      <desc>
+        Searches through all progress objects known to VBoxSVC for an
+        instance with the given GUID.
+        <note>
+          The method returns an error if the given GUID does not
+          correspond to any currently known progress object.
+        </note>
+      </desc>
+      <param name="id" type="uuid" mod="string" dir="in">
+        <desc>GUID of the progress object to search for.</desc>
+      </param>
+      <param name="progressObject" type="IProgress" dir="return">
+        <desc>Found progress object.</desc>
       </param>
     </method>
@@ -24466 +24483 @@
   <enum
     name="VBoxEventType"
-    uuid="2ab7c196-f232-11ea-a5d2-83b96bc30bcc"
+    uuid="c88a66ed-fbce-4c21-9196-12354bd96b89"
     >
 
@@ -24920 +24937 @@
       </desc>
     </const>
+    <const name="OnProgressCreated" value="110">
+      <desc>
+        See <link to="IProgressCreatedEvent"/>.
+      </desc>
+    </const>
     <!-- End event marker -->
     <!-- @todo rename to 'End' as it is exclusive (we use 'last' to be inclusive). -->
-    <const name="Last" value="110">
+    <const name="Last" value="111">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -27006 +27028 @@
     <attribute name="progressId" readonly="yes" type="uuid" mod="string">
       <desc>GUID of the progress this event relates to.</desc>
+    </attribute>
+
+  </interface>
+
+  <interface
+    name="IProgressCreatedEvent" extends="IProgressEvent"
+    uuid="a85bba40-1b93-47bb-b125-dec708c30fc0"
+    wsmap="managed" autogen="VBoxEvent" id="OnProgressCreated">
+    <desc>Notification of a new progress object creation/deletion. 
+      Covers purely projess objects in VBoxSVC. This
+      event is signaled on the event source of IVirtualBox, unlike
+      the other progress events.</desc>
+
+    <attribute name="create" readonly="yes" type="boolean">
+      <desc>If @c true, the progress object was created, otherwise it
+        was deleted.</desc>
     </attribute>
 

trunk/src/VBox/Main/include/VirtualBoxImpl.h

@@ -158 +158 @@
     int i_unloadVDPlugin(const char *pszPluginLibrary);
 
-    void i_onMediumRegistered(const Guid &aMediumId, const DeviceType_T aDevType, const BOOL aRegistered);
+    void i_onMediumRegistered(const Guid &aMediumId, const DeviceType_T aDevType, BOOL aRegistered);
     void i_onMediumConfigChanged(IMedium *aMedium);
     void i_onMediumChanged(IMediumAttachment* aMediumAttachment);
     void i_onStorageControllerChanged(const Guid &aMachineId, const com::Utf8Str &aControllerName);
-    void i_onStorageDeviceChanged(IMediumAttachment* aStorageDevice, const BOOL fRemoved, const BOOL fSilent);
+    void i_onStorageDeviceChanged(IMediumAttachment* aStorageDevice, BOOL fRemoved, BOOL fSilent);
     void i_onMachineStateChanged(const Guid &aId, MachineState_T aState);
     void i_onMachineDataChanged(const Guid &aId, BOOL aTemporary = FALSE);
@@ -199 +199 @@
     void i_onCloudProviderRegistered(const Utf8Str &aProviderId, BOOL aRegistered);
     void i_onCloudProviderUninstall(const Utf8Str &aProviderId);
+
+    void i_onProgressCreated(const Guid &aId, BOOL aCreated);
 
 #ifdef VBOX_WITH_CLOUD_NET
@@ -390 +392 @@
                                  com::Utf8Str &aFile,
                                  BOOL *aResult);
+    HRESULT findProgressById(const com::Guid &aId,
+                             ComPtr<IProgress> &aProgressObject);
 
     static HRESULT i_setErrorStaticBoth(HRESULT aResultCode, int vrc, const Utf8Str &aText)

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -1271 +1271 @@
     AutoReadLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
     ProgressMap pmap(m->mapProgressOperations);
+    /* Can release lock now. The following code works on a copy of the map. */
+    safeLock.release();
     aProgressOperations.resize(pmap.size());
     size_t i = 0;
@@ -3515 +3517 @@
 
 
+void VirtualBox::i_onProgressCreated(const Guid &aId, BOOL aCreated)
+{
+    ::FireProgressCreatedEvent(m->pEventSource, aId.toString(), aCreated);
+}
+
+
 /**
  *  @note Locks the list of other objects for reading.
@@ -5792 +5800 @@
 
 
+HRESULT VirtualBox::findProgressById(const com::Guid &aId,
+                                     ComPtr<IProgress> &aProgressObject)
+{
+    if (!aId.isValid())
+        return setError(E_INVALIDARG,
+                        tr("The provided progress object GUID is invalid"));
+
+    /* protect mProgressOperations */
+    AutoReadLock safeLock(m->mtxProgressOperations COMMA_LOCKVAL_SRC_POS);
+
+    ProgressMap::const_iterator it = m->mapProgressOperations.find(aId);
+    if (it != m->mapProgressOperations.end())
+    {
+        aProgressObject = it->second;
+        return S_OK;
+    }
+    return setError(E_INVALIDARG,
+                    tr("The progress object with the given GUID could not be found"));
+}
+
+
 #ifdef RT_OS_WINDOWS
 #include <psapi.h>
@@ -5998 +6027 @@
 
 /**
- * Wathces @a a_pidClient for termination.
+ * Watches @a a_pidClient for termination.
  *
  * @returns true if successfully enabled watching of it, false if not.