Changeset 100411 in vbox

Timestamp:

Jul 6, 2023 2:07:46 PM (20 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Renaming (shClSvcTransferSendStatusAsyncInternal -> shClSvcTransferSendStatusAsync), check for lock owner, docs. ​​​bugref:9437

File:

• trunk/src/VBox/HostServices/SharedClipboard/VBoxSharedClipboardSvc-transfers.cpp (modified) (11 diffs)

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

@@ -61 +61 @@
 *   Prototypes                                                                                                                   *
 *********************************************************************************************************************************/
-static int shClSvcTransferSendStatusAsyncInternal(PSHCLCLIENT pClient, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus, int rcTransfer, PSHCLEVENT *ppEvent);
+static int shClSvcTransferSendStatusAsync(PSHCLCLIENT pClient, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus, int rcTransfer, PSHCLEVENT *ppEvent);
 static int shClSvcTransferSetListOpen(uint32_t cParms, VBOXHGCMSVCPARM aParms[], uint64_t idCtx, PSHCLLISTOPENPARMS pOpenParms);
 static int shClSvcTransferSetListClose(uint32_t cParms, VBOXHGCMSVCPARM aParms[], uint64_t idCtx, SHCLLISTHANDLE hList);
@@ -1426 +1426 @@
                                             shClSvcClientLock(pClient);
 
-                                            rc = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                                                        SHCLTRANSFERSTATUS_REQUESTED, VINF_SUCCESS,
-                                                                                        NULL);
+                                            rc = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                                                                SHCLTRANSFERSTATUS_REQUESTED, VINF_SUCCESS,
+                                                                                NULL);
                                             shClSvcClientUnlock(pClient);
                                         }
@@ -2036 +2036 @@
 
         /* Let the guest know. */
-        int rc2 = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                         SHCLTRANSFERSTATUS_ERROR, rc, NULL /* ppEvent */);
+        int rc2 = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                                 SHCLTRANSFERSTATUS_ERROR, rc, NULL /* ppEvent */);
         AssertRC(rc2);
 
@@ -2120 +2120 @@
     /* ppEvent is optional. */
 
+    Assert(RTCritSectIsOwner(&pClient->CritSect));
+
     PSHCLCLIENTMSG pMsgReadData = shClSvcMsgAlloc(pClient, VBOX_SHCL_HOST_MSG_TRANSFER_STATUS,
                                                   VBOX_SHCL_CPARMS_TRANSFER_STATUS);
@@ -2165 +2167 @@
 
 /**
- * Reports a transfer status to the guest.
+ * Reports a transfer status to the guest, internal version.
  *
  * @returns VBox status code.
@@ -2177 +2179 @@
  * @note    Caller must enter the client's critical section.
  */
-static int shClSvcTransferSendStatusAsyncInternal(PSHCLCLIENT pClient, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus,
-                                                  int rcTransfer, PSHCLEVENT *ppEvent)
+static int shClSvcTransferSendStatusAsync(PSHCLCLIENT pClient, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus,
+                                          int rcTransfer, PSHCLEVENT *ppEvent)
 {
     AssertPtrReturn(pClient,   VERR_INVALID_POINTER);
@@ -2188 +2190 @@
 }
 
+/**
+ * Reports a transfer status to the guest.
+ *
+ * @returns VBox status code.
+ * @param   pClient             Client that owns the transfer.
+ * @param   pTransfer           Transfer to report status for.
+ * @param   uStatus             Status to report.
+ * @param   rcTransfer          Result code to report. Optional and depending on status.
+ * @param   ppEvent             Where to return the wait event on success. Optional.
+ *                              Must be released by the caller with ShClEventRelease().
+ */
 int ShClSvcTransferSendStatusAsync(PSHCLCLIENT pClient, PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS uStatus,
                                    int rcTransfer, PSHCLEVENT *ppEvent)
 {
-    shClSvcClientLock(pClient);
-
-    int rc = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer, uStatus, rcTransfer, ppEvent);
-
-    shClSvcClientUnlock(pClient);
-
-    return rc;
+    return shClSvcTransferSendStatusAsync(pClient, pTransfer, uStatus, rcTransfer, ppEvent);
 }
 
@@ -2222 +2229 @@
         {
             /* Let the guest know. */
-            int rc2 = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                             SHCLTRANSFERSTATUS_UNINITIALIZED, VINF_SUCCESS, NULL /* ppEvent */);
+            int rc2 = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                                     SHCLTRANSFERSTATUS_UNINITIALIZED, VINF_SUCCESS, NULL /* ppEvent */);
             AssertRC(rc2);
 
@@ -2358 +2365 @@
 
     /* Tell the guest the outcome. */
-    int rc2 = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                       RT_SUCCESS(rc)
-                                                     ? SHCLTRANSFERSTATUS_INITIALIZED : SHCLTRANSFERSTATUS_ERROR, rc,
-                                                     NULL /* ppEvent */);
+    int rc2 = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                               RT_SUCCESS(rc)
+                                             ? SHCLTRANSFERSTATUS_INITIALIZED : SHCLTRANSFERSTATUS_ERROR, rc,
+                                             NULL /* ppEvent */);
     if (RT_SUCCESS(rc))
         rc2 = rc;
@@ -2391 +2398 @@
     /* Let the guest know in any case
      * (so that it can tear down the transfer on error as well). */
-    int rc2 = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                     RT_SUCCESS(rc) ? SHCLTRANSFERSTATUS_STARTED : SHCLTRANSFERSTATUS_ERROR, rc,
-                                                     NULL /* ppEvent */);
+    int rc2 = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                              RT_SUCCESS(rc)
+                                            ? SHCLTRANSFERSTATUS_STARTED : SHCLTRANSFERSTATUS_ERROR, rc,
+                                            NULL /* ppEvent */);
     if (RT_SUCCESS(rc))
         rc = rc2;
@@ -2416 +2424 @@
 
     PSHCLEVENT pEvent;
-    int rc = shClSvcTransferSendStatusAsyncInternal(pClient, pTransfer,
-                                                    SHCLTRANSFERSTATUS_STOPPED, VINF_SUCCESS, &pEvent);
+    int rc = shClSvcTransferSendStatusAsync(pClient, pTransfer,
+                                            SHCLTRANSFERSTATUS_STOPPED, VINF_SUCCESS, &pEvent);
     if (   RT_SUCCESS(rc)
         && fWaitForGuest)