Changeset 32633 in vbox

Timestamp:

Sep 20, 2010 11:26:48 AM (14 years ago)

Author:

vboxsync

Message:

VbglR3GetSessionId,VBoxServiceVMInfo: Documented VbglR3GetSessionId behavior used in VBoxServiceVMInfoWorker. Some nits in VBoxServiceVMInfo.

Location:

trunk/src/VBox/Additions/common

Files:

• VBoxGuestLib/VBoxGuestR3LibMisc.cpp (modified) (2 diffs)
• VBoxService/VBoxServiceVMInfo.cpp (modified) (3 diffs)

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibMisc.cpp

@@ -75 +75 @@
 }
 
+
 /**
- * Query the session id of this VM; this is a unique id that gets changed for each VM start, reset or restore.
- * Useful for detection a VM restore.
+ * Query the session ID of this VM.
+ *
+ * The session id is an unique identifier that gets changed for each VM start,
+ * reset or restore.  Useful for detection a VM restore.
  *
  * @returns IPRT status code.
- * pu64IdSession    Session id (out)
- *
+ * @param   pu64IdSession       Session id (out).  This is NOT changed on
+ *                              failure, so the caller can depend on this to
+ *                              deal with backward compatability (see
+ *                              VBoxServiceVMInfoWorker() for an example.)
  */
 VBGLR3DECL(int) VbglR3GetSessionId(uint64_t *pu64IdSession)
@@ -88 +93 @@
 
     vmmdevInitRequest(&Req.header, VMMDevReq_GetSessionId);
+    Req.idSession = 0;
     int rc = vbglR3GRPerform(&Req.header);
-    if (rc == VINF_SUCCESS)
+    if (RT_SUCCESS(rc))
         *pu64IdSession = Req.idSession;
 

trunk/src/VBox/Additions/common/VBoxService/VBoxServiceVMInfo.cpp

@@ -77 +77 @@
 /** The guest property cache. */
 static VBOXSERVICEVEPROPCACHE   g_VMInfoPropCache;
-/** The session ID. Changes whenever the VM is restored or resetted. */
-static uint64_t                 g_idSession;
+/** The VM session ID. Changes whenever the VM is restored or reset. */
+static uint64_t                 g_idVMInfoSession;
 
 
@@ -115 +115 @@
     int rc = RTSemEventMultiCreate(&g_hVMInfoEvent);
     AssertRCReturn(rc, rc);
-    
-    rc = VbglR3GetSessionId(&g_idSession);
-    /* The error ignored as this information is not available with VBox < 3.2.10. */
+
+    VbglR3GetSessionId(&g_idVMInfoSession);
+    /* The status code is ignored as this information is not available with VBox < 3.2.10. */
 
     rc = VbglR3GuestPropConnect(&g_uVMInfoGuestPropSvcClientID);
@@ -746 +746 @@
          * Flush all properties if we were restored.
          */
-        uint64_t idNewSession = g_idSession;
+        uint64_t idNewSession = g_idVMInfoSession;
         VbglR3GetSessionId(&idNewSession);
-        if (idNewSession != g_idSession)
-        {
-            VBoxServiceVerbose(3, "VMInfo: Session ID changed, flushing all properties.\n");
+        if (idNewSession != g_idVMInfoSession)
+        {
+            VBoxServiceVerbose(3, "VMInfo: The VM session ID changed, flushing all properties.\n");
             vboxserviceVMInfoWriteFixedProperties();
             VBoxServicePropCacheFlush(&g_VMInfoPropCache);
-            g_idSession = idNewSession;
+            g_idVMInfoSession = idNewSession;
         }