Changeset 95504 in vbox for trunk/src/VBox/HostServices

Timestamp:

Jul 4, 2022 4:49:06 PM (2 years ago)

Author:

vboxsync

Message:

Guest Control/Host Service: Documented and slightly refactored ClientState::Wakeup() to only use one return point (easier for logging). bugref:10157

File:

• trunk/src/VBox/HostServices/GuestControl/VBoxGuestControlSvc.cpp (modified) (4 diffs)

trunk/src/VBox/HostServices/GuestControl/VBoxGuestControlSvc.cpp

@@ -522 +522 @@
      * Used by for Service::hostProcessMessage().
      *
+     * @returns VBox status code.
+     * @retval  VINF_NO_CHANGE if the client has not been woken up.
+     *
      * @note This wakes up both GUEST_MSG_WAIT and GUEST_MSG_PEEK_WAIT sleepers.
      */
@@ -528 +531 @@
         int rc = VINF_NO_CHANGE;
 
+        LogFlowFunc(("[Client %RU32] enmPendingMsg=%RU32, idSession=%RU32, fIsMaster=%RTbool, fRestored=%RTbool\n",
+                     m_idClient, m_enmPendingMsg, m_idSession, m_fIsMaster, m_fRestored));
+
         if (m_enmPendingMsg != 0)
         {
-            LogFlowFunc(("[Client %RU32] Waking up ...\n", m_idClient));
-
             rc = VINF_SUCCESS;
 
@@ -545 +549 @@
                     rc = m_pSvcHelpers->pfnCallComplete(m_PendingReq.mHandle, VINF_SUCCESS);
 
-                    m_PendingReq.mHandle   = NULL;
-                    m_PendingReq.mParms    = NULL;
-                    m_PendingReq.mNumParms = 0;
+                    m_PendingReq.mHandle    = NULL;
+                    m_PendingReq.mParms     = NULL;
+                    m_PendingReq.mNumParms  = 0;
                     m_enmPendingMsg         = (guestControl::eGuestMsg)0;
                 }
@@ -557 +561 @@
             else
                 AssertMsgFailed(("Waking up client ID=%RU32 with no host message in queue is a bad idea\n", m_idClient));
-
-            return rc;
-        }
-
-        return VINF_NO_CHANGE;
+        }
+
+        LogFlowFuncLeaveRC(rc);
+        return rc;
     }