Changeset 24258 in vbox

Timestamp:

Nov 2, 2009 2:38:50 PM (15 years ago)

Author:

vboxsync

Message:

Main: new method Medium::RefreshState() which refreshes medium state; make the ::state attribute return the state only without refreshing

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManageDisk.cpp (modified) (2 diffs)
• Frontends/VBoxManage/VBoxManageList.cpp (modified) (3 diffs)
• Frontends/VirtualBox/src/VBoxMedium.cpp (modified) (1 diff)
• Main/ApplianceImpl.cpp (modified) (1 diff)
• Main/MachineImpl.cpp (modified) (6 diffs)
• Main/MediumImpl.cpp (modified) (5 diffs)
• Main/idl/VirtualBox.xidl (modified) (4 diffs)
• Main/include/MediumImpl.h (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageDisk.cpp

@@ -684 +684 @@
                 /* Perform accessibility check now. */
                 MediumState_T state;
-                CHECK_ERROR_BREAK(dstDisk, COMGETTER(State)(&state));
+                CHECK_ERROR_BREAK(dstDisk, RefreshState(&state));
             }
             CHECK_ERROR_BREAK(dstDisk, COMGETTER(Format) (format.asOutParam()));
@@ -1216 +1216 @@
         /// @todo NEWMEDIA print the full state value
         MediumState_T state;
-        CHECK_ERROR_BREAK (hardDisk, COMGETTER(State)(&state));
+        CHECK_ERROR_BREAK (hardDisk, RefreshState(&state));
         RTPrintf("Accessible:           %s\n", state != MediumState_Inaccessible ? "yes" : "no");
 

trunk/src/VBox/Frontends/VBoxManage/VBoxManageList.cpp

@@ -527 +527 @@
                 /// @todo NEWMEDIA check accessibility of all parents
                 /// @todo NEWMEDIA print the full state value
-                hdd->COMGETTER(State)(&enmState);
+                hdd->RefreshState(&enmState);
                 RTPrintf("Accessible:   %s\n", enmState != MediumState_Inaccessible ? "yes" : "no");
 
@@ -583 +583 @@
                 RTPrintf("Path:       %lS\n", filePath.raw());
                 MediumState_T enmState;
-                dvdImage->COMGETTER(State)(&enmState);
+                dvdImage->RefreshState(&enmState);
                 RTPrintf("Accessible: %s\n", enmState != MediumState_Inaccessible ? "yes" : "no");
                 /** @todo usage */
@@ -605 +605 @@
                 RTPrintf("Path:       %lS\n", filePath.raw());
                 MediumState_T enmState;
-                floppyImage->COMGETTER(State)(&enmState);
+                floppyImage->RefreshState(&enmState);
                 RTPrintf("Accessible: %s\n", enmState != MediumState_Inaccessible ? "yes" : "no");
                 /** @todo usage */

trunk/src/VBox/Frontends/VirtualBox/src/VBoxMedium.cpp

@@ -47 +47 @@
     if (mMedium.isNull()) return;
 
-    mState = mMedium.GetState();
+    mState = mMedium.RefreshState();
 
     /* Save the result to distinguish between inaccessible and e.g. uninitialized objects */

trunk/src/VBox/Main/ApplianceImpl.cpp

@@ -4477 +4477 @@
                 // force reading state, or else size will be returned as 0
                 MediumState_T ms;
-                rc = pMedium->COMGETTER(State)(&ms);
+                rc = pMedium->RefreshState(&ms);
                 if (FAILED(rc)) throw rc;
 

trunk/src/VBox/Main/MachineImpl.cpp

@@ -8790 +8790 @@
                                             IProgress **aProgress)
 {
-    LogFlowThisFunc(("\n"));
+    LogFlowThisFuncEnter();
 
     Guid id(aId);
@@ -8870 +8870 @@
     *aMachineState = mData->mMachineState;
 
+    LogFlowThisFuncLeave();
+
     return S_OK;
 }
@@ -8881 +8883 @@
                                              IProgress **aProgress)
 {
-    LogFlowThisFunc(("\n"));
+    LogFlowThisFuncEnter();
 
     AssertReturn(aInitiator, E_INVALIDARG);
@@ -8957 +8959 @@
                              RTTHREADTYPE_MAIN_WORKER,
                              0,
-                             "DiscardCurState");
+                             "RestoreSnap");
     if (RT_FAILURE(vrc))
     {
@@ -8972 +8974 @@
     /* return the new state to the caller */
     *aMachineState = mData->mMachineState;
+
+    LogFlowThisFuncLeave();
 
     return S_OK;
@@ -10308 +10312 @@
                 if (mediumState == MediumState_Inaccessible)
                 {
-                    rc = medium->COMGETTER(State)(&mediumState);
+                    rc = medium->RefreshState(&mediumState);
                     CheckComRCThrowRC(rc);
 

trunk/src/VBox/Main/MediumImpl.cpp

@@ -417 +417 @@
            that the medium isn't fully initialized yet. */
         MediumState_T m;
-        rc = aMedium->COMGETTER(State)(&m);
+        rc = aMedium->RefreshState(&m);
         CheckComRCReturnRC(rc);
         /* go to Deleting */
@@ -678 +678 @@
             if (mediaState == MediumState_Inaccessible)
             {
-                rc = (*it)->COMGETTER(State)(&mediaState);
+                rc = (*it)->RefreshState(&mediaState);
                 CheckComRCReturnRC(rc);
                 Assert(mediaState == MediumState_LockedRead);
@@ -735 +735 @@
             if (mediaState == MediumState_Inaccessible)
             {
-                rc = (*it)->COMGETTER(State)(&mediaState);
+                rc = (*it)->RefreshState(&mediaState);
                 CheckComRCReturnRC(rc);
                 if (it == last)
@@ -1371 +1371 @@
     CheckComRCReturnRC(autoCaller.rc());
 
-    /* queryInfo() locks this for writing. */
-    AutoWriteLock alock(this);
-
-    HRESULT rc = S_OK;
-
-    switch (m->state)
-    {
-        case MediumState_Created:
-        case MediumState_Inaccessible:
-        case MediumState_LockedRead:
-        case MediumState_LockedWrite:
-        {
-            rc = queryInfo();
-            break;
-        }
-        default:
-            break;
-    }
-
+    AutoReadLock alock(this);
     *aState = m->state;
 
-    return rc;
-}
+    return S_OK;
+}
+
 
 STDMETHODIMP Medium::COMGETTER(Location)(BSTR *aLocation)
@@ -1756 +1739 @@
 
     return S_OK;
+}
+
+STDMETHODIMP Medium::RefreshState(MediumState_T *aState)
+{
+    CheckComArgOutPointerValid(aState);
+
+    AutoCaller autoCaller(this);
+    CheckComRCReturnRC(autoCaller.rc());
+
+    /* queryInfo() locks this for writing. */
+    AutoWriteLock alock(this);
+
+    HRESULT rc = S_OK;
+
+    switch (m->state)
+    {
+        case MediumState_Created:
+        case MediumState_Inaccessible:
+        case MediumState_LockedRead:
+        {
+            rc = queryInfo();
+            break;
+        }
+        default:
+            break;
+    }
+
+    *aState = m->state;
+
+    return rc;
 }
 

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

@@ -8554 +8554 @@
       When the storage unit cannot be read (for example, because it is located on
       a disconnected network resource, or was accidentally deleted outside VirtualBox),
-      the medium is considered to be <i>inaccessible</i>, which is indicated by the
+      the medium is considered <i>inaccessible</i>, which is indicated by the
       "Inaccessible" state. The exact reason why the medium is inaccessible can be
       obtained by reading the <link to="#lastAccessError"/> attribute.
 
-      A new accessibility check is performed each time the <link to="#state"/>
-      attribute is read. This check may take long time (several seconds or even
-      minutes, depending on the storage unit location and format), and will
-      block the calling thread until finished. For this reason, it is recommended
-      to never read this attribute on the main UI thread to avoid making the UI
-      unresponsive.
+      A new accessibility check is performed when <link to="#refreshState"/>
+      is called; otherwise the <link to="#state"/> attribute returns the state
+      from the last refresh.
 
       Note that when VirtualBox starts up (e.g. the VirtualBox object gets
@@ -8844 +8841 @@
     <attribute name="state" type="MediumState" readonly="yes">
       <desc>
-        Current medium state. Inspect <link to="MediumState"/> values for details.
-
-        Reading this attribute may take a long time because an accessibility
-        check of the storage unit is performed each time the attribute is read.
-        This check may cause a significant delay if the storage unit of the
-        given medium is, for example, a file located on a network share which is
-        not currently accessible due to connectivity problems -- the call will
-        not return until a timeout interval defined by the host OS for this
-        operation expires.
-
-        If the last known state of the medium is <link to="MediumState_Created"/>
-        and the accessibility check fails then the state would be set to
-        <link to="MediumState_Inaccessible"/> and <link to="#lastAccessError"/>
-        may be used to get more details about the failure. If the state of the
-        medium is <link to="MediumState_LockedRead"/> or
-        <link to="MediumState_LockedWrite"/> then it remains the same, and a
-        non-empty value of <link to="#lastAccessError"/> will indicate a failed
-        accessibility check in this case.
-
-        Note that not all medium states are applicable to all medium types.
+        Returns the current medium state, which is the last state set by
+        the accessibility check performed by <link to="#refreshState"/>.
+        If that method has not yet been called on the medium, the state
+        is "Inaccessible"; as opposed to truly inaccessible media, the
+        value of <link to="#lastAccessError"/> will be an empty string in
+        that case.
+
+        <note>As of version 3.1, this no longer performs an accessibility check
+          automatically; call <link to="#refreshState"/> for that.
+        </note>
       </desc>
     </attribute>
@@ -9076 +9063 @@
       <desc>
         Text message that represents the result of the last accessibility
-        check.
-
-        Accessibility checks are performed each time the <link to="#state"/>
-        attribute is read. An empty string is returned if the last
-        accessibility check was successful. A non-empty string indicates a
-        failure and should normally describe a reason of the failure (for
-        example, a file read error).
+        check performed by <link to="#refreshState"/>.
+
+        An empty string is returned if the last accessibility check
+        was successful or has not yet been called. As a result, if
+        <link to="#state" /> is "Inaccessible" and this attribute is empty,
+        then <link to="#refreshState"/> has yet to be called; this is the
+        default value of media after VirtualBox initialization.
+        A non-empty string indicates a failure and should normally describe
+        a reason of the failure (for example, a file read error).
       </desc>
     </attribute>
@@ -9101 +9090 @@
       </desc>
     </attribute>
+
+    <method name="refreshState">
+      <desc>
+        If the current medium state (see <link to="MediumState"/>
+        and <link to="#state" /> is one of "Created", "Inaccessible"
+        or "LockedRead", then this performs an accessibility check on the
+        medium and sets the value of the <link to="#state"/> attribute
+        accordingly; that value is also returned for convenience.
+
+        For all other state values, this does not perform a refresh but returns
+        the state only.
+
+        The refresh, if performed, may take a long time (several seconds or even
+        minutes, depending on the storage unit location and format) because it performs an
+        accessibility check of the storage unit. This check may cause a significant
+        delay if the storage unit of the given medium is, for example, a file located
+        on a network share which is not currently accessible due to connectivity
+        problems. In that case, the call will not return until a timeout
+        interval defined by the host OS for this operation expires. For this reason,
+        it is recommended to never read this attribute on the main UI thread to avoid
+        making the UI unresponsive.
+
+        If the last known state of the medium is "Created" and the accessibility
+        check fails, then the state would be set to "Inaccessible", and
+        <link to="#lastAccessError"/> may be used to get more details about the
+        failure. If the state of the medium is "LockedRead", then it remains the
+        same, and a non-empty value of <link to="#lastAccessError"/> will
+        indicate a failed accessibility check in this case.
+
+        Note that not all medium states are applicable to all medium types.
+      </desc>
+      <param name="state" type="MediumState" dir="return">
+        <desc>
+          New medium state.
+        </desc>
+      </param>
+    </method>
 
     <method name="getSnapshotIds">

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

@@ -122 +122 @@
 
     // IMedium methods
+    STDMETHOD(RefreshState)(MediumState_T *aState);
     STDMETHOD(GetSnapshotIds)(IN_BSTR aMachineId,
                               ComSafeArrayOut(BSTR, aSnapshotIds));