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

Timestamp:

Oct 22, 2019 9:52:40 AM (5 years ago)

Author:

vboxsync

Message:

Shared Clipboard/Svc: Split up client initialization / resetting code into own functions for better testing coverage.

Location:

trunk/src/VBox/HostServices/SharedClipboard

Files:

• VBoxSharedClipboardSvc-internal.h (modified) (1 diff)
• VBoxSharedClipboardSvc.cpp (modified) (8 diffs)

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-internal.h

@@ -198 +198 @@
 int shclSvcMsgGet(PSHCLCLIENT pClient, VBOXHGCMCALLHANDLE hCall, uint32_t cParms, VBOXHGCMSVCPARM paParms[]);
 
+int shclSvcClientInit(PSHCLCLIENT pClient, uint32_t uClientID);
+void shclSvcClientReset(PSHCLCLIENT pClient);
+
+int shclSvcClientStateInit(PSHCLCLIENTSTATE pClientState, uint32_t uClientID);
+int shclSvcClientStateDestroy(PSHCLCLIENTSTATE pClientState);
+void shclSvcClientStateReset(PSHCLCLIENTSTATE pClientState);
+
 int shclSvcClientWakeup(PSHCLCLIENT pClient);
 

trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc.cpp

@@ -239 +239 @@
 
 /*********************************************************************************************************************************
-*   Prototypes                                                                                                                   *
-*********************************************************************************************************************************/
-static int shclSvcClientStateInit(PSHCLCLIENTSTATE pClientState, uint32_t uClientID);
-static int shclSvcClientStateDestroy(PSHCLCLIENTSTATE pClientState);
-static void shclSvcClientStateReset(PSHCLCLIENTSTATE pClientState);
-
-
-/*********************************************************************************************************************************
 *   Global Variables                                                                                                             *
 *********************************************************************************************************************************/
@@ -508 +500 @@
 
     return VINF_SUCCESS;
+}
+
+/**
+ * Initializes a Shared Clipboard client.
+ *
+ * @param   pClient             Client to initialize.
+ * @param   uClientID           HGCM client ID to assign client to.
+ */
+int shclSvcClientInit(PSHCLCLIENT pClient, uint32_t uClientID)
+{
+    AssertPtrReturn(pClient, VERR_INVALID_POINTER);
+
+    /* Assign the client ID. */
+    pClient->State.uClientID = uClientID;
+
+    LogFlowFunc(("[Client %RU32]\n", pClient->State.uClientID));
+
+    /* Create the client's own event source. */
+    int rc = ShClEventSourceCreate(&pClient->Events, 0 /* ID, ignored */);
+    if (RT_SUCCESS(rc))
+    {
+        LogFlowFunc(("[Client %RU32] Using event source %RU32\n", uClientID, pClient->Events.uID));
+
+        /* Reset the client state. */
+        shclSvcClientStateReset(&pClient->State);
+
+        /* (Re-)initialize the client state. */
+        rc = shclSvcClientStateInit(&pClient->State, uClientID);
+
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+        if (RT_SUCCESS(rc))
+            rc = ShClTransferCtxInit(&pClient->TransferCtx);
+#endif
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
+ * Resets a Shared Clipboard client.
+ *
+ * @param   pClient             Client to reset.
+ */
+void shclSvcClientReset(PSHCLCLIENT pClient)
+{
+    if (!pClient)
+        return;
+
+    LogFlowFunc(("[Client %RU32]\n", pClient->State.uClientID));
+
+    /* Reset message queue. */
+    shclSvcMsgQueueReset(pClient);
+
+    /* Reset event source. */
+    ShClEventSourceReset(&pClient->Events);
+
+    /* Reset pending state. */
+    RT_ZERO(pClient->Pending);
+
+#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
+    shclSvcClientTransfersReset(pClient);
+#endif
+
+    shclSvcClientStateReset(&pClient->State);
 }
 
@@ -1273 +1330 @@
     }
 
-    shclSvcClientStateReset(&pClient->State);
     shclSvcClientStateDestroy(&pClient->State);
-
     ShClEventSourceDestroy(&pClient->Events);
 
@@ -1296 +1351 @@
     AssertPtr(pvClient);
 
-    /* Assign the client ID. */
-    pClient->State.uClientID = u32ClientID;
-
-    /* Create the client's own event source. */
-    int rc = ShClEventSourceCreate(&pClient->Events, 0 /* ID, ignored */);
+    int rc = shclSvcClientInit(pClient, u32ClientID);
     if (RT_SUCCESS(rc))
     {
-        LogFlowFunc(("[Client %RU32] Using event source %RU32\n", u32ClientID, pClient->Events.uID));
-
-        /* Reset the client state. */
-        shclSvcClientStateReset(&pClient->State);
-
-        /* (Re-)initialize the client state. */
-        rc = shclSvcClientStateInit(&pClient->State, u32ClientID);
+        rc = ShClSvcImplConnect(pClient, ShClSvcGetHeadless());
         if (RT_SUCCESS(rc))
         {
-#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
-            rc = ShClTransferCtxInit(&pClient->TransferCtx);
-#endif
-            if (RT_SUCCESS(rc))
-                rc = ShClSvcImplConnect(pClient, ShClSvcGetHeadless());
-            if (RT_SUCCESS(rc))
-            {
-                /* Assign weak pointer to client map .*/
-                g_mapClients[u32ClientID] = pClient; /** @todo Handle OOM / collisions? */
-
-                /* For now we ASSUME that the first client ever connected is in charge for
-                 * communicating withe the service extension.
-                 *
-                 ** @todo This needs to be fixed ASAP w/o breaking older guest / host combos. */
-                if (g_ExtState.uClientID == 0)
-                    g_ExtState.uClientID = u32ClientID;
-            }
+            /* Assign weak pointer to client map .*/
+            g_mapClients[u32ClientID] = pClient; /** @todo Handle OOM / collisions? */
+
+            /* For now we ASSUME that the first client ever connected is in charge for
+             * communicating withe the service extension.
+             *
+             ** @todo This needs to be fixed ASAP w/o breaking older guest / host combos. */
+            if (g_ExtState.uClientID == 0)
+                g_ExtState.uClientID = u32ClientID;
         }
     }
@@ -1684 +1721 @@
  * @param   uClientID           Client ID (HGCM) to use for this client state.
  */
-static int shclSvcClientStateInit(PSHCLCLIENTSTATE pClientState, uint32_t uClientID)
+int shclSvcClientStateInit(PSHCLCLIENTSTATE pClientState, uint32_t uClientID)
 {
     LogFlowFuncEnter();
@@ -1702 +1739 @@
  * @param   pClientState        Client state to destroy.
  */
-static int shclSvcClientStateDestroy(PSHCLCLIENTSTATE pClientState)
+int shclSvcClientStateDestroy(PSHCLCLIENTSTATE pClientState)
 {
     RT_NOREF(pClientState);
@@ -1716 +1753 @@
  * @param   pClientState    Client state to reset.
  */
-static void shclSvcClientStateReset(PSHCLCLIENTSTATE pClientState)
+void shclSvcClientStateReset(PSHCLCLIENTSTATE pClientState)
 {
     LogFlowFuncEnter();
@@ -1728 +1765 @@
 #ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
     pClientState->Transfers.enmTransferDir = SHCLTRANSFERDIR_UNKNOWN;
-#else
-    RT_NOREF(pClientState);
 #endif
 }