Changeset 73743 in vbox for trunk/src/VBox/Main/include/ProgressImpl.h

Timestamp:

Aug 17, 2018 5:56:34 PM (6 years ago)

Author:

vboxsync

Message:

Main/Progress+Appliance+Machine: Turn IProgress::waitForAsyncProgressCompletion into an internal method. It is not needed by any client code outside the API, it's simply is too special. Also include the error propagation which it originally skipped (leding to reduntant code in the calling code). Remove a replicated version of it from the Appliance code which seems to be the half-forgotten ancestor of the method in IProgress. Adapt the users of the method to the new internal method, which made the code easier to read.

File:

• trunk/src/VBox/Main/include/ProgressImpl.h (modified) (2 diffs)

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

@@ -138 +138 @@
     HRESULT i_notifyCompleteEI(HRESULT aResultCode,
                                const ComPtr<IVirtualBoxErrorInfo> &aErrorInfo);
+    /**
+     * Waits until the other task is completed (including all sub-operations)
+     * and forward all changes from the other progress to this progress. This
+     * means sub-operation number, description, percent and so on.
+     *
+     * The caller is responsible for having at least the same count of
+     * sub-operations in this progress object as there are in the other
+     * progress object.
+     *
+     * If the other progress object supports cancel and this object gets any
+     * cancel request (when here enabled as well), it will be forwarded to
+     * the other progress object.
+     *
+     * Error information is automatically preserved (by transferring it to
+     * the current thread's error information). If the caller wants to set it
+     * as the completion state of this progress it needs to be done separately.
+     *
+     * @param   aProgressOther  Progress object from which the state is
+     *                  forwarded until it is signalling completion.
+     * @return COM error status, also reflecting the failed completion.
+     */
+    HRESULT i_waitForOtherProgressCompletion(const ComPtr<IProgress> &aProgressOther);
 
     bool i_notifyPointOfNoReturn(void);
@@ -213 +235 @@
     HRESULT waitForOperationCompletion(ULONG aOperation,
                                        LONG aTimeout);
-    HRESULT waitForAsyncProgressCompletion(const ComPtr<IProgress> &aPProgressAsync);
     HRESULT cancel();