Changeset 44970 in vbox

Timestamp:

Mar 11, 2013 9:59:05 AM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

84190

Message:

Main/VirtualBoxClient: add method to perform VM error checking which simplifies client code
com/ErrorInfo: small bugfix (the object where the error information originated was always lost), added a way to inject whole error object structures which needed the bugfix
Frontends/VBoxSDL: sample code how to use the new method

Location:

trunk

Files:

• include/VBox/com/ErrorInfo.h (modified) (2 diffs)
• src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp (modified) (3 diffs)
• src/VBox/Main/glue/ErrorInfo.cpp (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/include/VirtualBoxClientImpl.h (modified) (2 diffs)
• src/VBox/Main/src-client/VirtualBoxClientImpl.cpp (modified) (3 diffs)

trunk/include/VBox/com/ErrorInfo.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2011 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -445 +445 @@
 
     /**
+     *  Constructs a new instance from an ErrorInfo object, to inject a full
+     *  error info created elsewhere.
+     *
+     *  @param aInfo    @c true to prevent fetching error info and leave
+     *                  the instance uninitialized.
+     */
+    ErrorInfoKeeper(const ErrorInfo &aInfo)
+        : ErrorInfo(false), mForgot(false)
+    {
+        copyFrom(aInfo);
+    }
+
+    /**
      *  Destroys this instance and automatically calls #restore() which will
      *  either restore error info fetched by the constructor or do nothing

trunk/src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2012 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1446 +1446 @@
         else
         {
-            RTPrintf("Error: machine with the given ID not found!\n");
+            RTPrintf("Error: machine with the given name not found!\n");
+            RTPrintf("Check if this VM has been corrupted and is now inaccessible.");
             goto leave;
         }
@@ -1454 +1455 @@
     vrc = RTSemEventCreate(&g_EventSemSDLEvents);
     AssertReleaseRC(vrc);
+
+    rc = pVirtualBoxClient->CheckMachineError(pMachine);
+    if (FAILED(rc))
+    {
+        com::ErrorInfo info;
+        if (info.isFullAvailable())
+            PrintError("The VM has errors",
+                       info.getText().raw(), info.getComponent().raw());
+        else
+            RTPrintf("Failed to check for VM errors! No error information available (rc=%Rhrc).\n", rc);
+        goto leave;
+    }
 
     rc = pMachine->LockMachine(pSession, LockType_VM);

trunk/src/VBox/Main/glue/ErrorInfo.cpp

@@ -7 +7 @@
 
 /*
- * Copyright (C) 2006-2011 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -266 +266 @@
     mIsBasicAvailable = gotSomething;
     mIsFullAvailable = gotAll;
+
+    mErrorInfo = info;
 
     AssertMsg(gotSomething, ("Nothing to fetch!\n"));

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

@@ -18285 +18285 @@
   <interface
     name="IVirtualBoxClient" extends="$unknown"
-    uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
+    uuid="d191281f-b0cb-4d83-a8fa-0d9fd6ba234c"
     wsmap="suppress"
     >
@@ -18315 +18315 @@
     </attribute>
 
+    <method name="checkMachineError">
+      <desc>
+        Perform error checking before using an <link to="IMachine"/> object.
+        Generally useful before starting a VM and all other uses. If anything
+        is not as it should be then this method will return an appropriate
+        error.
+      </desc>
+
+      <param name="machine" type="IMachine" dir="in">
+        <desc>The machine object to check.</desc>
+      </param>
+    </method>
   </interface>
 

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

@@ -6 +6 @@
 
 /*
- * Copyright (C) 2010-2011 Oracle Corporation
+ * Copyright (C) 2010-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -60 +60 @@
     STDMETHOD(COMGETTER(Session))(ISession **aSession);
     STDMETHOD(COMGETTER(EventSource))(IEventSource **aEventSource);
+    STDMETHOD(CheckMachineError)(IMachine *aMachine);
 
 private:

trunk/src/VBox/Main/src-client/VirtualBoxClientImpl.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2010-2011 Oracle Corporation
+ * Copyright (C) 2010-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -21 +21 @@
 #include "VBoxEvents.h"
 #include "Logging.h"
+#include "VBox/com/ErrorInfo.h"
 
 #include <iprt/asm.h>
@@ -199 +200 @@
 
     return mData.m_pEventSource.isNull() ? E_FAIL : S_OK;
+}
+
+/**
+ * Checks a Machine object for any pending errors.
+ *
+ * @returns COM status code
+ * @param   aMachine    Machine object to check.
+ */
+STDMETHODIMP VirtualBoxClient::CheckMachineError(IMachine *aMachine)
+{
+    HRESULT rc;
+    CheckComArgNotNull(aMachine);
+
+    BOOL fAccessible = FALSE;
+    rc = aMachine->COMGETTER(Accessible)(&fAccessible);
+    if (FAILED(rc))
+        return setError(rc, tr("Could not check the accessibility status of the VM"));
+    else if (!fAccessible)
+    {
+        ComPtr<IVirtualBoxErrorInfo> pAccessError;
+        rc = aMachine->COMGETTER(AccessError)(pAccessError.asOutParam());
+        if (FAILED(rc))
+            return setError(rc, tr("Could not get the access error message of the VM"));
+        else
+        {
+            ErrorInfo info(pAccessError);
+            ErrorInfoKeeper eik(info);
+            return info.getResultCode();
+        }
+    }
+    return S_OK;
 }