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

Timestamp:

Feb 27, 2007 5:33:11 PM (18 years ago)

Author:

vboxsync

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

18964

Message:

Main: Added new IMachine attributes: description, sessionType and sessionPid.

Location:

trunk/src/VBox/Main

Files:

• MachineImpl.cpp (modified) (13 diffs)
• idl/VirtualBox.xidl (modified) (7 diffs)
• include/MachineImpl.h (modified) (4 diffs)
• xml/VirtualBox-settings-common.xsd (modified) (1 diff)
• xml/samples/VirtualBox-machine-windows.xml (modified) (1 diff)

trunk/src/VBox/Main/MachineImpl.cpp

@@ -795 +795 @@
 }
 
+STDMETHODIMP Machine::COMGETTER(Description) (BSTR *aDescription)
+{
+    if (!aDescription)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoReaderLock alock (this);
+
+    mUserData->mDescription.cloneTo (aDescription);
+
+    return S_OK;
+}
+
+STDMETHODIMP Machine::COMSETTER(Description) (INPTR BSTR aDescription)
+{
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoLock alock (this);
+
+    CHECK_SETTER();
+
+    mUserData.backup();
+    mUserData->mDescription = aDescription;
+
+    return S_OK;
+}
+
 STDMETHODIMP Machine::COMGETTER(Id) (GUIDPARAMOUT aId)
 {
@@ -1177 +1207 @@
 }
 
-STDMETHODIMP Machine::COMGETTER(SessionState) (SessionState_T *sessionState)
-{
-    if (!sessionState)
+STDMETHODIMP Machine::COMGETTER(SessionState) (SessionState_T *aSessionState)
+{
+    if (!aSessionState)
         return E_POINTER;
 
@@ -1187 +1217 @@
     AutoReaderLock alock (this);
 
-    *sessionState = mData->mSession.mState;
+    *aSessionState = mData->mSession.mState;
+
+    return S_OK;
+}
+
+STDMETHODIMP Machine::COMGETTER(SessionType) (BSTR *aSessionType)
+{
+    if (!aSessionType)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoReaderLock alock (this);
+
+    mData->mSession.mType.cloneTo (aSessionType);
+
+    return S_OK;
+}
+
+STDMETHODIMP Machine::COMGETTER(SessionPid) (ULONG *aSessionPid)
+{
+    if (!aSessionPid)
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoReaderLock alock (this);
+
+    *aSessionPid = mData->mSession.mPid;
 
     return S_OK;
@@ -2367 +2427 @@
     AssertReturn (mData->mMachineState < MachineState_Running, E_FAIL);
 
+    /* get the sesion PID */
+    RTPROCESS pid = NIL_RTPROCESS;
+    AssertCompile (sizeof (ULONG) == sizeof (RTPROCESS));
+    aControl->GetPID ((ULONG *) &pid);
+    Assert (pid != NIL_RTPROCESS);
+
     if (mData->mSession.mState == SessionState_SessionSpawning)
     {
-        /*
-         *  this machine awaits for a spawning session to be opened,
-         *  so reject any other open attempts from processes other than
-         *  one started by #openRemoteSession().
-         */
-
-        RTPROCESS pid = NIL_RTPROCESS; AssertCompile (sizeof (ULONG) == sizeof (RTPROCESS));
-        aControl->GetPID ((ULONG *)&pid);
+        /* This machine is awaiting for a spawning session to be opened, so
+         * reject any other open attempts from processes other than one
+         * started by #openRemoteSession(). */
 
         LogFlowThisFunc (("mSession.mPid=%d(0x%x)\n",
@@ -2476 +2537 @@
         /* Note that the progress object is finalized later */
 
-        /* We don't reset mSession.mPid here because it is necessary for
-         * SessionMachine::uninit() to reap the child process later. */
+        /* We don't reset mSession.mPid and mType here because both are
+         * necessary for SessionMachine::uninit() to reap the child process
+         * later. */
 
         if (FAILED (rc))
@@ -2486 +2548 @@
             mData->mSession.mState = SessionState_SessionClosed;
         }
+    }
+    else
+    {
+        /* memorize PID of the directly opened session */
+        if (SUCCEEDED (rc))
+            mData->mSession.mPid = pid;
     }
 
@@ -2636 +2704 @@
     mData->mSession.mPid = pid;
     mData->mSession.mState = SessionState_SessionSpawning;
+    mData->mSession.mType = type;
 
     LogFlowThisFuncLeave();
@@ -3055 +3124 @@
             CFGLDRQueryBool (machineNode, "nameSync", &nameSync);
             mUserData->mNameSync = nameSync;
+        }
+
+        /* Description (optional, default is null) */
+        {
+            CFGNODE descNode = 0;
+            CFGLDRGetChildNode (machineNode, "Description", 0, &descNode);
+            if (descNode)
+            {
+                CFGLDRQueryBSTR (descNode, NULL,
+                                 mUserData->mDescription.asOutParam());
+                CFGLDRReleaseNode (descNode);
+            }
+            else
+                mUserData->mDescription.setNull();
         }
 
@@ -3290 +3373 @@
             CFGNODE descNode = 0;
             CFGLDRGetChildNode (aNode, "Description", 0, &descNode);
-            CFGLDRQueryBSTR (descNode, NULL, description.asOutParam());
-            CFGLDRReleaseNode (descNode);
+            if (descNode)
+            {
+                CFGLDRQueryBSTR (descNode, NULL, description.asOutParam());
+                CFGLDRReleaseNode (descNode);
+            }
         }
 
@@ -4682 +4768 @@
             CFGLDRDeleteAttribute (machineNode, "nameSync");
 
+        /* Description node (optional) */
+        if (!mUserData->mDescription.isNull())
+        {
+            CFGNODE descNode = 0;
+            CFGLDRCreateChildNode (machineNode, "Description", &descNode);
+            Assert (descNode);
+            CFGLDRSetBSTR (descNode, NULL, mUserData->mDescription);
+            CFGLDRReleaseNode (descNode);
+        }
+        else
+        {
+            CFGNODE descNode = 0;
+            CFGLDRGetChildNode (machineNode, "Description", 0, &descNode);
+            if (descNode)
+                CFGLDRDeleteNode (descNode);
+        }
+
         /* OSType (required) */
         {
@@ -5099 +5202 @@
 
     /* Description node (optional) */
+    if (!aSnapshot->data().mDescription.isNull())
     {
         CFGNODE descNode = 0;
         CFGLDRCreateChildNode (aNode, "Description", &descNode);
+        Assert (descNode);
         CFGLDRSetBSTR (descNode, NULL, aSnapshot->data().mDescription);
         CFGLDRReleaseNode (descNode);
+    }
+    else
+    {
+        CFGNODE descNode = 0;
+        CFGLDRGetChildNode (aNode, "Description", 0, &descNode);
+        if (descNode)
+            CFGLDRDeleteNode (descNode);
     }
 
@@ -7086 +7198 @@
     mParent->host()->releaseAllUSBDevices (this);
 
-    if (mData->mSession.mPid != NIL_RTPROCESS)
-    {
-        /*
-         *  pid is not NIL, meaning this machine's process has been started
-         *  using VirtualBox::OpenRemoteSession(), thus it is our child.
-         *  we need to queue this pid to be reaped (to avoid zombies on Linux)
-         */
+    if (!mData->mSession.mType.isNull())
+    {
+        /* mType is not null when this machine's process has been started by
+         * VirtualBox::OpenRemoteSession(), therefore it is our child.  We
+         * need to queue the PID to reap the process (and avoid zombies on
+         * Linux). */
+        Assert (mData->mSession.mPid != NIL_RTPROCESS);
         mParent->addProcessToReap (mData->mSession.mPid);
-        mData->mSession.mPid = NIL_RTPROCESS;
-    }
+    }
+
+    mData->mSession.mPid = NIL_RTPROCESS;
 
     if (aReason == Uninit::Unexpected)
     {
-        /*
-         *  uninitialization didn't come from #checkForDeath(), so tell the
-         *  client watcher thread to update the set of machines that have
-         *  open sessions.
-         */
+        /* Uninitialization didn't come from #checkForDeath(), so tell the
+         * client watcher thread to update the set of machines that have open
+         * sessions. */
         mParent->updateClientWatcher();
     }
@@ -7162 +7273 @@
     mData->mSession.mMachine.setNull();
     mData->mSession.mState = SessionState_SessionClosed;
+    mData->mSession.mType.setNull();
 
     /* close the interprocess semaphore before leaving the shared lock */

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

@@ -1369 +1369 @@
                 it is invalid.
                 </p>
+
+                Currently supported session types (values of the @a type
+                parameter) are:
+                <ul>
+                    <li><tt>gui</tt>: VirtualBox Qt GUI session</li>
+                    <li><tt>vrdp</tt>: VirtualBox VRDP Server session</li>
+                </ul>
+
                 <note>
                     It is impossible to open a remote session with the machine
@@ -1375 +1383 @@
                     (see <link to="IMachine::sessionState"/>).
                 </note>
+
+                <note>
+                    The opened @a session will be automatically closed when
+                    the corresponding direct session dies or gets closed.
+                </note>
+
                 <see>openExistingSession</see>
             </desc>
@@ -1380 +1394 @@
                 <desc>
                     Session object that will represent the opened remote session
-                    after successful method invocation. This object must not
-                    represent an already open session.
-                    <note>
-                        This session will be automatically closed when the peer
-                        (direct) session dies or gets closed.
-                    </note>
+                    after successful method invocation (this object must not
+                    represent an already open session).
                 </desc>
             </param>
@@ -1393 +1403 @@
             <param name="type" type="wstring" dir="in">
                 <desc>
-                    Type of the remote session (case sensitive). Currently
-                    supported values are:
-                    <ul>
-                        <li><tt>gui</tt>: Qt-based VM session</li>
-                        <li><tt>rdp</tt>: VRDP server session</li>
-                    </ul>
+                    Type of the remote session (case sensitive).
                 </desc>
             </param>
@@ -1760 +1765 @@
     <interface
         name="IMachine" extends="$unknown"
-        uuid="FD443EC1-0009-4F5B-9282-D72760A66916"
+        uuid="50fa9181-d2d4-45ca-bf0e-742677b9c707"
     >
         <attribute name="parent" type="IVirtualBox" readonly="yes">
@@ -1876 +1881 @@
         </attribute>
 
+        <attribute name="description" type="wstring">
+            <desc>
+                Description of the virtual machine.
+
+                The description attribute can contain any text and is
+                typically used to describe the hardware and software
+                configuration of the virtual machine in detail (i.e. network
+                settings, versions of the installed software and so on).
+            </desc>
+        </attribute>
+
         <attribute name="id" type="uuid" readonly="yes">
             <desc>UUID of the virtual machine.</desc>
@@ -2001 +2017 @@
         <attribute name="sessionState" type="SessionState" readonly="yes">
             <desc>Current session state for this machine.</desc>
+        </attribute>
+
+        <attribute name="sessionType" type="wstring" readonly="yes">
+            <desc>
+                Type of the session.  If <link to="#sessionState"/> is
+                SessionSpawning or SessionOpen, this attribute contains the
+                same value as passed to the
+                <link to="IVirtualBox::openRemoteSession()"/> method in the @a
+                type parameter. If the session was opened directly using
+                <link to="IVirtualBox::openSession()"/>, or if
+                <link to="#sessionState"/> is SessionClosed, the value of this
+                attribute is @c null.
+            </desc>
+        </attribute>
+
+        <attribute name="sessionPid" type="unsigned long" readonly="yes">
+            <desc>
+                Identifier of the session process. This attribute contains the
+                platform-dependent identifier of the process that has opened a
+                direct session for this machine using the
+                <link to="IVirtualBox::openSession()"/> call. The returned value
+                is only valid if <link to="#sessionState"/> is SessionOpen or
+                SessionClosing (i.e. a session is currently open or being
+                closed) by the time this property is read.
+            </desc>
         </attribute>
 

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

@@ -142 +142 @@
             RTPROCESS mPid;
 
-            /** current session state */
+            /** Current session state */
             SessionState_T mState;
 
-            /** sesison machine object */
+            /** Session type string (for indirect sessions) */
+            Bstr mType;
+
+            /** Sesison machine object */
             ComObjPtr <SessionMachine> mMachine;
         };
@@ -210 +213 @@
                    (mName == that.mName &&
                     mNameSync == that.mNameSync &&
+                    mDescription == that.mDescription &&
                     mOSType.equalsTo (that.mOSType) &&
                     mSnapshotFolderFull == that.mSnapshotFolderFull);
         }
 
-        Bstr   mName;
-        BOOL   mNameSync;
+        Bstr    mName;
+        BOOL    mNameSync;
+        Bstr    mDescription;
         ComPtr <IGuestOSType> mOSType;
-        Bstr   mSnapshotFolder;
-        Bstr   mSnapshotFolderFull;
+        Bstr    mSnapshotFolder;
+        Bstr    mSnapshotFolderFull;
     };
 
@@ -305 +310 @@
     STDMETHOD(COMGETTER(Name))(BSTR *aName);
     STDMETHOD(COMSETTER(Name))(INPTR BSTR aName);
+    STDMETHOD(COMGETTER(Description))(BSTR *aDescription);
+    STDMETHOD(COMSETTER(Description))(INPTR BSTR aDescription);
     STDMETHOD(COMGETTER(Id))(GUIDPARAMOUT aId);
     STDMETHOD(COMGETTER(OSType)) (IGuestOSType **aOSType);
@@ -325 +332 @@
     STDMETHOD(COMGETTER(SettingsFilePath))(BSTR *filePath);
     STDMETHOD(COMGETTER(SettingsModified))(BOOL *modified);
-    STDMETHOD(COMGETTER(SessionState))(SessionState_T *sessionState);
+    STDMETHOD(COMGETTER(SessionState))(SessionState_T *aSessionState);
+    STDMETHOD(COMGETTER(SessionType))(BSTR *aSessionType);
+    STDMETHOD(COMGETTER(SessionPid))(ULONG *aSessionPid);
     STDMETHOD(COMGETTER(State))(MachineState_T *machineState);
     STDMETHOD(COMGETTER(LastStateChange))(LONG64 *aLastStateChange);

trunk/src/VBox/Main/xml/VirtualBox-settings-common.xsd

@@ -553 +553 @@
 <xsd:complexType name="TMachine">
   <xsd:all>
+    <xsd:element name="Description" type="xsd:string" minOccurs="0"/>
     <xsd:element name="Hardware" type="THardware"/>
     <xsd:element name="HardDiskAttachments" type="THardDiskAttachments"/>

trunk/src/VBox/Main/xml/samples/VirtualBox-machine-windows.xml

@@ -20 +20 @@
     aborted="true"
   >
+    <Description>
+        Something is here.
+    </Description>
     <Hardware>
       <Memory RAMSize="128"/>