Changeset 21978 in vbox for trunk/src/VBox/Additions

Timestamp:

Aug 5, 2009 11:07:39 AM (15 years ago)

Author:

vboxsync

Message:

VbglR3: u32Timeout -> cMillies and other nitpicking.

Location:

trunk/src/VBox/Additions/common/VBoxGuestLib

Files:

• VBoxGuestR3LibGuestProp.cpp (modified) (3 diffs)
• VBoxGuestR3LibMisc.cpp (modified) (1 diff)

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

@@ -811 +811 @@
  * @param   u64Timestamp    The timestamp of the last event seen.  Pass zero
  *                          to wait for the next event.
- * @param   u32Timeout      Timeout in milliseconds.  Use RT_INDEFINITE_WAIT
+ * @param   cMillies        Timeout in milliseconds.  Use RT_INDEFINITE_WAIT
  *                          to wait indefinitely.
  * @param   ppszName        Where to store the pointer to the name retrieved.
@@ -825 +825 @@
                                     const char *pszPatterns,
                                     void *pvBuf, uint32_t cbBuf,
-                                    uint64_t u64Timestamp, uint32_t u32Timeout,
+                                    uint64_t u64Timestamp, uint32_t cMillies,
                                     char ** ppszName, char **ppszValue,
                                     uint64_t *pu64Timestamp, char **ppszFlags,
@@ -835 +835 @@
     GetNotification Msg;
 
-    Msg.hdr.u32Timeout = u32Timeout;
+    Msg.hdr.u32Timeout = cMillies;
     Msg.hdr.fInterruptible = true;
     Msg.hdr.info.result = VERR_WRONG_ORDER;

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

@@ -31 +31 @@
 
 /**
- * Wait for the host to signal one or several of a set of events and return the
- * events signalled.  The events will only be delivered by the host if they
- * have been enabled previously using @a VbglR3CtlFilterMask.  If one or
- * several of the events have already been signalled but not yet waited for,
- * this function will return immediately and return those events.
+ * Wait for the host to signal one or more events and return which.
  *
- * @returns iprt status code
- * @param   fMask       the events we want to wait for, or-ed together
- * @param   u32Timeout  how long to wait before giving up and returning.  Use
- *                      RT_INDEFINITE_WAIT to wait until we are interrupted or
- *                      one of the events is signalled.
- * @param   pfEvents    where to store the events signalled
+ * The events will only be delivered by the host if they have been enabled
+ * previously using @a VbglR3CtlFilterMask.  If one or several of the events
+ * have already been signalled but not yet waited for, this function will return
+ * immediately and return those events.
+ *
+ * @returns IPRT status code
+ *
+ * @param   fMask       The events we want to wait for, or-ed together.
+ * @param   cMillies    How long to wait before giving up and returning
+ *                      (VERR_TIMEOUT). Use RT_INDEFINITE_WAIT to wait until we
+ *                      are interrupted or one of the events is signalled.
+ * @param   pfEvents    Where to store the events signalled. Optional.
  */
-VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t u32Timeout,
-                                uint32_t *pfEvents)
+VBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents)
 {
-    LogFlowFunc(("fMask=0x%x, u32Timeout=%u, pfEvents=%p\n", fMask, u32Timeout,
-                 pfEvents));
-    AssertReturn((fMask & ~VMMDEV_EVENT_VALID_EVENT_MASK) == 0,
-                 VERR_INVALID_PARAMETER);
-    /* Does pfEvents == NULL make sense? */
-    AssertReturn(VALID_PTR(pfEvents) || pfEvents == NULL,
-                 VERR_INVALID_POINTER);
+    LogFlow(("VbglR3WaitEvent: fMask=0x%x, cMillies=%u, pfEvents=%p\n",
+             fMask, cMillies, pfEvents));
+    AssertReturn((fMask & ~VMMDEV_EVENT_VALID_EVENT_MASK) == 0, VERR_INVALID_PARAMETER);
+    AssertPtrNullReturn(pfEvents, VERR_INVALID_POINTER);
 
     VBoxGuestWaitEventInfo waitEvent;
-    int rc;
-
-    waitEvent.u32TimeoutIn = u32Timeout;
+    waitEvent.u32TimeoutIn = cMillies;
     waitEvent.u32EventMaskIn = fMask;
     waitEvent.u32Result = VBOXGUEST_WAITEVENT_ERROR;
     waitEvent.u32EventFlagsOut = 0;
-    rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
-    if (RT_SUCCESS(rc) && (pfEvents) != NULL)
-        *pfEvents = waitEvent.u32EventFlagsOut;
-    LogFlowFunc(("rc=%Rrc, waitEvent.u32EventFlagsOut=0x%x\n", rc,
-                 waitEvent.u32EventFlagsOut));
+    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
+    if (RT_SUCCESS(rc))
+    {
+        AssertMsg(waitEvent.u32Result == VBOXGUEST_WAITEVENT_OK, ("%d\n", waitEvent.u32Result));
+        if (pfEvents)
+            *pfEvents = waitEvent.u32EventFlagsOut;
+    }
+
+    LogFlow(("VbglR3WaitEvent: rc=%Rrc, u32EventFlagsOut=0x%x. u32Result=%d\n",
+             rc, waitEvent.u32EventFlagsOut, waitEvent.u32Result));
     return rc;
 }