Changeset 15834 in vbox for trunk/src/VBox/Main/SessionImpl.cpp

Timestamp:

Jan 7, 2009 2:17:56 PM (16 years ago)

Author:

vboxsync

Message:

#3285: Improve error handling API to include unique error numbers
Document InternalSessionControl's

• getRemoteConsole
• assignMachine
• assignRemoteMachine
• updateMachineState
• uninitialize
• onDVDDriveChange
• onFloppyDriveChange
• onNetworkAdapterChange
• onSerialPortChange
• onParallelPortChange
• onVRDPServerChange
• onUSBControllerChange
• onSharedFolderChange
• onUSBDeviceAttach
• onUSBDeviceDetach
• onShowWindow
• accessGuestProperty
• enumerateGuestProperties

File:

• trunk/src/VBox/Main/SessionImpl.cpp (modified) (20 diffs)

trunk/src/VBox/Main/SessionImpl.cpp

@@ -266 +266 @@
     AutoReadLock alock (this);
 
-    AssertReturn (mState != SessionState_Closed, E_FAIL);
+    AssertReturn (mState != SessionState_Closed, VBOX_E_INVALID_VM_STATE);
 
     AssertMsgReturn (mType == SessionType_Direct && !!mConsole,
-                     ("This is not a direct session!\n"), E_FAIL);
+      ("This is not a direct session!\n"), VBOX_E_INVALID_OBJECT_STATE);
 
     /* return a failure if the session already transitioned to Closing
      * but the server hasn't processed Machine::OnSessionEnd() yet. */
     if (mState != SessionState_Open)
-        return E_UNEXPECTED;
+        return VBOX_E_INVALID_VM_STATE;
 
     mConsole.queryInterfaceTo (aConsole);
@@ -291 +291 @@
     AutoWriteLock alock (this);
 
-    AssertReturn (mState == SessionState_Closed, E_FAIL);
+    AssertReturn (mState == SessionState_Closed, VBOX_E_INVALID_VM_STATE);
 
     if (!aMachine)
@@ -302 +302 @@
          */
 
-        AssertReturn (mType == SessionType_Null, E_FAIL);
+        AssertReturn (mType == SessionType_Null, VBOX_E_INVALID_OBJECT_STATE);
         mType = SessionType_Remote;
         mState = SessionState_Spawning;
@@ -363 +363 @@
 
     AssertReturn (mState == SessionState_Closed ||
-                  mState == SessionState_Spawning, E_FAIL);
+                  mState == SessionState_Spawning, VBOX_E_INVALID_VM_STATE);
 
     HRESULT rc = E_FAIL;
@@ -369 +369 @@
     /* query IInternalMachineControl interface */
     mControl = aMachine;
-    AssertReturn (!!mControl, E_FAIL);
+    AssertReturn (!!mControl, E_FAIL); // This test appears to be redundant --JS
 
     /// @todo (dmik)
@@ -445 +445 @@
     }
 
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     AssertReturn (!mControl.isNull(), E_FAIL);
@@ -476 +476 @@
 
         AssertReturn (mState == SessionState_Open ||
-                      mState == SessionState_Spawning, E_FAIL);
+                      mState == SessionState_Spawning, VBOX_E_INVALID_VM_STATE);
 
         /* close ourselves */
@@ -509 +509 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onDVDDriveChange();
@@ -523 +523 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onFloppyDriveChange();
@@ -537 +537 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onNetworkAdapterChange(networkAdapter);
@@ -551 +551 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onSerialPortChange(serialPort);
@@ -565 +565 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onParallelPortChange(parallelPort);
@@ -579 +579 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onVRDPServerChange();
@@ -593 +593 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onUSBControllerChange();
@@ -607 +607 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onSharedFolderChange (aGlobal);
@@ -623 +623 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onUSBDeviceAttach (aDevice, aError, aMaskedIfs);
@@ -638 +638 @@
 
     AutoReadLock alock (this);
-    AssertReturn (mState == SessionState_Open &&
-                  mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mState == SessionState_Open, VBOX_E_INVALID_VM_STATE);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     return mConsole->onUSBDeviceDetach (aId, aError);
@@ -651 +651 @@
     AutoReadLock alock (this);
 
-    AssertReturn (mType == SessionType_Direct, E_FAIL);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
 
     if (mState != SessionState_Open)
@@ -678 +678 @@
             tr ("Machine session is not open (session state: %d)."),
             mState);
-    AssertReturn (mType == SessionType_Direct, E_UNEXPECTED);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
     CheckComArgNotNull(aName);
     if (!aIsSetter && !VALID_PTR (aRetValue))
@@ -712 +712 @@
 
     if (mState != SessionState_Open)
-        return setError (E_FAIL,
+        return setError (VBOX_E_INVALID_VM_STATE,
             tr ("Machine session is not open (session state: %d)."),
             mState);
-    AssertReturn (mType == SessionType_Direct, E_UNEXPECTED);
+    AssertReturn (mType == SessionType_Direct, VBOX_E_INVALID_OBJECT_STATE);
     if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
         return E_POINTER;