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

Timestamp:

May 11, 2015 2:09:09 PM (10 years ago)

Author:

vboxsync

Message:

Main/Session+Machine: small API cleanup, introducing explicit session names and eliminating some terminology confusion (it never was a session type, which is a totally different thing)

Location:

trunk/src/VBox/Main

Files:

• idl/VirtualBox.xidl (modified) (6 diffs)
• include/MachineImpl.h (modified) (2 diffs)
• include/SessionImpl.h (modified) (3 diffs)
• src-client/SessionImpl.cpp (modified) (2 diffs)
• src-server/MachineImpl.cpp (modified) (14 diffs)

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

@@ -4170 +4170 @@
   <interface
     name="IMachine" extends="$unknown"
-    uuid="701464d0-7284-42e9-b7b3-894cf31536b7"
+    uuid="77a44043-a68a-4ef9-ac26-e9567b1e6bbc"
     wsmap="managed"
     wrap-hint-server-addinterfaces="IInternalMachineControl"
@@ -4670 +4670 @@
     </attribute>
 
-    <attribute name="sessionType" type="wstring" readonly="yes">
-      <desc>
-        Type of the session. If <link to="#sessionState"/> is
+    <attribute name="sessionName" type="wstring" readonly="yes">
+      <desc>
+        Name of the session. If <link to="#sessionState"/> is
         Spawning or Locked, this attribute contains the
         same value as passed to the
         <link to="IMachine::launchVMProcess"/> method in the
-        @a type parameter. If the session was used with
-        <link to="IMachine::lockMachine" />, or if
+        @a name parameter. If the session was established with
+        <link to="IMachine::lockMachine" />, it is the name of the session
+        (if set, otherwise empty string). If
         <link to="#sessionState"/> is SessionClosed, the value of this
         attribute is an empty string.
@@ -5191 +5192 @@
         </desc>
       </param>
-      <param name="type" type="wstring" dir="in">
+      <param name="name" type="wstring" dir="in">
         <desc>
           Front-end to use for the new VM process. The following are currently supported:
@@ -19266 +19267 @@
   <interface
     name="ISession" extends="$unknown"
-    uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
+    uuid="3d4f472c-aac8-4387-94be-54042bcd8901"
     wsmap="managed"
     wrap-hint-server-addinterfaces="IInternalSessionControl"
@@ -19339 +19340 @@
     </attribute>
 
+    <attribute name="name" type="wstring">
+      <desc>
+        Name of this session. Important only for VM sessions, otherwise it
+        it will be remembered, but not used for anything significant (and can
+        be left at the empty string which is the default). The value can only
+        be changed when the session state is SessionState_Unlocked. Make sure
+        that you use a descriptive name which does not conflict with the VM
+        process session names: "GUI/Qt", "GUI/SDL" and "headless".
+      </desc>
+    </attribute>
+
     <attribute name="machine" type="IMachine" readonly="yes">
       <desc>Machine object associated with this session.</desc>
@@ -19344 +19356 @@
 
     <attribute name="console" type="IConsole" readonly="yes">
-      <desc>Console object associated with this session.</desc>
+      <desc>Console object associated with this session. Only sessions
+      which locked the machine for a VM process have a non-null console.</desc>
     </attribute>
 

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

@@ -149 +149 @@
             SessionState_T mState;
 
-            /** Session type string (for indirect sessions) */
-            Utf8Str mType;
+            /** Session name string (of the primary session) */
+            Utf8Str mName;
 
             /** Session machine object */
@@ -928 +928 @@
     HRESULT getSettingsModified(BOOL *aSettingsModified);
     HRESULT getSessionState(SessionState_T *aSessionState);
-    HRESULT getSessionType(com::Utf8Str &aSessionType);
+    HRESULT getSessionType(SessionType_T *aSessionType);
+    HRESULT getSessionName(com::Utf8Str &aSessionType);
     HRESULT getSessionPID(ULONG *aSessionPID);
     HRESULT getState(MachineState_T *aState);

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2014 Oracle Corporation
+ * Copyright (C) 2006-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -57 +57 @@
     HRESULT getState(SessionState_T *aState);
     HRESULT getType(SessionType_T *aType);
+    HRESULT getName(com::Utf8Str &aName);
+    HRESULT setName(const com::Utf8Str &aName);
     HRESULT getMachine(ComPtr<IMachine> &aMachine);
     HRESULT getConsole(ComPtr<IConsole> &aConsole);
@@ -143 +145 @@
     SessionState_T mState;
     SessionType_T mType;
+    Utf8Str mName;
 
     ComPtr<IInternalMachineControl> mControl;

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2014 Oracle Corporation
+ * Copyright (C) 2006-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -149 +149 @@
 
     *aType = mType;
+    return S_OK;
+}
+
+HRESULT Session::getName(com::Utf8Str &aName)
+{
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    aName = mName;
+    return S_OK;
+}
+
+HRESULT Session::setName(const com::Utf8Str &aName)
+{
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    if (mState != SessionState_Unlocked)
+        return setError(VBOX_E_INVALID_OBJECT_STATE, tr("Trying to set name for a session which is not in state \"unlocked\""));
+
+    mName = aName;
     return S_OK;
 }

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -2674 +2674 @@
 HRESULT Machine::getSessionState(SessionState_T *aSessionState)
 {
-
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
@@ -2682 +2681 @@
 }
 
-HRESULT Machine::getSessionType(com::Utf8Str &aSessionType)
+HRESULT Machine::getSessionName(com::Utf8Str &aSessionName)
 {
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    aSessionType = mData->mSession.mType;
+    aSessionName = mData->mSession.mName;
 
     return S_OK;
@@ -3223 +3222 @@
                     E_INVALIDARG);
 
+    // session name (only used in some code paths)
+    Utf8Str strSessionName;
+
     AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
 
@@ -3437 +3439 @@
                          tr("Failed to assign the machine to the session (%Rhrc)"), rc);
 
+            // get session name, either to remember or to compare against
+            // the already known session name.
+            {
+                Bstr bstrSessionName;
+                HRESULT rc2 = aSession->COMGETTER(Name)(bstrSessionName.asOutParam());
+                if (SUCCEEDED(rc2))
+                    strSessionName = bstrSessionName;
+            }
+
             if (    SUCCEEDED(rc)
                  && fLaunchingVMProcess
@@ -3485 +3496 @@
         if (fLaunchingVMProcess)
         {
+            Assert(mData->mSession.mName == strSessionName);
             /* Note that the progress object is finalized later */
             /** @todo Consider checking mData->mSession.mProgress for cancellation
@@ -3522 +3534 @@
             mData->mSession.mDirectControl = pSessionControl;
             mData->mSession.mState = SessionState_Locked;
+            if (!fLaunchingVMProcess)
+                mData->mSession.mName = strSessionName;
             /* associate the SessionMachine with this Machine */
             mData->mSession.mMachine = sessionMachine;
@@ -3561 +3575 @@
  */
 HRESULT Machine::launchVMProcess(const ComPtr<ISession> &aSession,
-                                 const com::Utf8Str &aType,
+                                 const com::Utf8Str &aName,
                                  const com::Utf8Str &aEnvironment,
                                  ComPtr<IProgress> &aProgress)
 {
-    Utf8Str strFrontend(aType);
+    Utf8Str strFrontend(aName);
     /* "emergencystop" doesn't need the session, so skip the checks/interface
      * retrieval. This code doesn't quite fit in here, but introducing a
@@ -7430 +7444 @@
     if (fSeparate)
     {
-        if (mData->mSession.mState != SessionState_Unlocked && mData->mSession.mType.compare("headless", Utf8Str::CaseInsensitive))
+        if (mData->mSession.mState != SessionState_Unlocked && mData->mSession.mName == "headless")
             return setError(VBOX_E_INVALID_OBJECT_STATE,
                             tr("The machine '%s' is in a state which is incompatible with launching a separate UI process"),
@@ -7531 +7545 @@
 #endif
 
+    Utf8Str strCanonicalName;
 
 #ifdef VBOX_WITH_QTGUI
@@ -7539 +7554 @@
         || !strFrontend.compare("GUI/Qt/separate", Utf8Str::CaseInsensitive))
     {
+        strCanonicalName = "GUI/Qt";
 # ifdef RT_OS_DARWIN /* Avoid Launch Services confusing this with the selector by using a helper app. */
         /* Modify the base path so that we don't need to use ".." below. */
@@ -7607 +7623 @@
         || !strFrontend.compare("GUI/SDL/separate", Utf8Str::CaseInsensitive))
     {
+        strCanonicalName = "GUI/SDL";
         static const char s_szVBoxSDL_exe[] = "VBoxSDL" HOSTSUFF_EXE;
         Assert(cchBufLeft >= sizeof(s_szVBoxSDL_exe));
@@ -7641 +7658 @@
        )
     {
+        strCanonicalName = "headless";
         /* On pre-4.0 the "headless" type was used for passing "--vrdp off" to VBoxHeadless to let it work in OSE,
          * which did not contain VRDP server. In VBox 4.0 the remote desktop server (VRDE) is optional,
@@ -7732 +7750 @@
         mData->mSession.mPID = pid;
         mData->mSession.mState = SessionState_Spawning;
-        mData->mSession.mType = strFrontend;
+        Assert(strCanonicalName.isNotEmpty());
+        mData->mSession.mName = strCanonicalName;
     }
     else
@@ -12654 +12673 @@
     mData->mSession.mMachine.setNull();
     mData->mSession.mState = SessionState_Unlocked;
-    mData->mSession.mType.setNull();
+    mData->mSession.mName.setNull();
 
     /* destroy the machine client token before leaving the exclusive lock */