Changeset 24961 in vbox for trunk/src/VBox/Main

Timestamp:

Nov 25, 2009 4:02:32 PM (15 years ago)

Author:

vboxsync

Message:

Main: Added a timeout property to IProgress that can be used to automatically time out an operation. This is to make life simpler on the client side.

Location:

trunk/src/VBox/Main

Files:

• ProgressImpl.cpp (modified) (3 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)
• include/ProgressImpl.h (modified) (3 diffs)

trunk/src/VBox/Main/ProgressImpl.cpp

@@ -60 +60 @@
     mResultCode = S_OK;
 
-    m_cOperations =
-    m_ulTotalOperationsWeight =
-    m_ulOperationsCompletedWeight =
-    m_ulCurrentOperation =
-    m_ulCurrentOperationWeight =
-    m_ulOperationPercent = 0;
+    m_cOperations
+        = m_ulTotalOperationsWeight
+        = m_ulOperationsCompletedWeight
+        = m_ulCurrentOperation
+        = m_ulCurrentOperationWeight
+        = m_ulOperationPercent
+        = m_cMsTimeout
+        = 0;
 
     // get creation timestamp
@@ -467 +469 @@
         *aOperationPercent = m_ulOperationPercent;
 
+    return S_OK;
+}
+
+STDMETHODIMP ProgressBase::COMSETTER(Timeout)(ULONG aTimeout)
+{
+    AutoCaller autoCaller(this);
+    CheckComRCReturnRC(autoCaller.rc());
+
+    AutoWriteLock alock(this);
+
+    if (!mCancelable)
+        return setError(VBOX_E_INVALID_OBJECT_STATE,
+                        tr("Operation cannot be canceled"));
+
+    LogThisFunc(("%#x => %#x\n", m_cMsTimeout, aTimeout));
+    m_cMsTimeout = aTimeout;
+    return S_OK;
+}
+
+STDMETHODIMP ProgressBase::COMGETTER(Timeout)(ULONG *aTimeout)
+{
+    CheckComArgOutPointerValid(aTimeout);
+
+    AutoCaller autoCaller(this);
+    CheckComRCReturnRC(autoCaller.rc());
+
+    AutoReadLock alock(this);
+
+    *aTimeout = m_cMsTimeout;
     return S_OK;
 }
@@ -1472 +1503 @@
 }
 
+STDMETHODIMP CombinedProgress::COMSETTER(Timeout)(ULONG aTimeout)
+{
+    NOREF(aTimeout);
+    AssertFailed();
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CombinedProgress::COMGETTER(Timeout)(ULONG *aTimeout)
+{
+    CheckComArgOutPointerValid(aTimeout);
+
+    AssertFailed();
+    return E_NOTIMPL;
+}
+
 // IProgress methods
 /////////////////////////////////////////////////////////////////////////////

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

@@ -8296 +8296 @@
   <interface
      name="IProgress" extends="$unknown"
-     uuid="62827ef1-c098-40eb-be96-36d0508489a6"
+     uuid="856aa038-853f-42e2-acf7-6e7b02dbe294"
      wsmap="managed"
      >
@@ -8418 +8418 @@
     <attribute name="operationPercent" type="unsigned long" readonly="yes">
         <desc>Progress value of the current sub-operation only, in percent.</desc>
+    </attribute>
+
+    <attribute name="timeout" type="unsigned long">
+      <desc>
+          When non-zero, this specifies the number of milliseconds after which
+          the operation will automatically be canceled.  This can only be set on
+          cancelable objects.
+      </desc>
     </attribute>
 

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

@@ -82 +82 @@
     STDMETHOD(COMGETTER(OperationDescription)) (BSTR *aOperationDescription);
     STDMETHOD(COMGETTER(OperationPercent)) (ULONG *aOperationPercent);
+    STDMETHOD(COMSETTER(Timeout)) (ULONG aTimeout);
+    STDMETHOD(COMGETTER(Timeout)) (ULONG *aTimeout);
 
     // public methods only for internal purposes
@@ -130 +132 @@
     ULONG m_ulCurrentOperationWeight;               // weight of current operation, given to setNextOperation()
     ULONG m_ulOperationPercent;                     // percentage of current operation, set with setCurrentOperationProgress()
+    ULONG m_cMsTimeout;                             /**< Automatic timeout value. 0 means none. */
 };
 
@@ -409 +412 @@
     STDMETHOD(COMGETTER(OperationDescription)) (BSTR *aOperationDescription);
     STDMETHOD(COMGETTER(OperationPercent)) (ULONG *aOperationPercent);
+    STDMETHOD(COMSETTER(Timeout)) (ULONG aTimeout);
+    STDMETHOD(COMGETTER(Timeout)) (ULONG *aTimeout);
 
     // IProgress methods