Changeset 100393 in vbox for trunk/src/VBox/GuestHost/SharedClipboard

Timestamp:

Jul 5, 2023 4:18:02 PM (21 months ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

158133

Message:

Shared Clipboard: Made setting the transfer callbacks part of ShClTransferCreate(), otherwise the pfnOnCreated callback won't be called. ​​bugref:9437

Location:

trunk/src/VBox/GuestHost/SharedClipboard

Files:

• clipboard-transfers.cpp (modified) (7 diffs)
• testcase/tstClipboardHttpServer.cpp (modified) (1 diff)

trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp

@@ -44 +44 @@
 
 
+
+/*********************************************************************************************************************************
+ * Prototypes                                                                                                                    *
+ ********************************************************************************************************************************/
+
+static void shClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst, PSHCLTRANSFERCALLBACKS pCallbacksSrc);
 DECLINLINE(void) shClTransferLock(PSHCLTRANSFER pTransfer);
 DECLINLINE(void) shClTransferUnlock(PSHCLTRANSFER pTransfer);
+static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks);
 static int shClTransferSetStatus(PSHCLTRANSFER pTransfer, SHCLTRANSFERSTATUS enmStatus);
 static int shClTransferThreadCreate(PSHCLTRANSFER pTransfer, PFNRTTHREAD pfnThreadFunc, void *pvUser);
@@ -1052 +1059 @@
  * @param   enmDir              Specifies the transfer direction of this transfer.
  * @param   enmSource           Specifies the data source of the transfer.
+ * @param   pCallbacks          Callback table to use. Optional and can be NULL.
  * @param   cbMaxChunkSize      Maximum transfer chunk size (in bytes) to use.
  * @param   cMaxListHandles     Maximum list entries the transfer can have.
@@ -1058 +1066 @@
  *                              Must be destroyed by ShClTransferDestroy().
  */
-int ShClTransferCreateEx(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource,
+int ShClTransferCreateEx(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource, PSHCLTRANSFERCALLBACKS pCallbacks,
                          uint32_t cbMaxChunkSize, uint32_t cMaxListHandles, uint32_t cMaxObjHandles, PSHCLTRANSFER *ppTransfer)
 {
-
-
     AssertPtrReturn(ppTransfer, VERR_INVALID_POINTER);
+    /* pCallbacks can be NULL. */
 
     LogFlowFuncEnter();
@@ -1096 +1103 @@
     RT_ZERO(pTransfer->ProviderCtx);
     RT_ZERO(pTransfer->ProviderIface);
+
+    /* Make sure to set the callbacks before calling pfnOnCreate below. */
+    shClTransferSetCallbacks(pTransfer, pCallbacks);
 
     ShClTransferListInit(&pTransfer->lstRoots);
@@ -1132 +1142 @@
  * @param   enmDir              Specifies the transfer direction of this transfer.
  * @param   enmSource           Specifies the data source of the transfer.
+ * @param   pCallbacks          Callback table to use. Optional and can be NULL.
  * @param   ppTransfer          Where to return the created clipboard transfer struct.
  *                              Must be destroyed by ShClTransferDestroy().
  */
-int ShClTransferCreate(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource, PSHCLTRANSFER *ppTransfer)
-{
-    return ShClTransferCreateEx(enmDir, enmSource,
+int ShClTransferCreate(SHCLTRANSFERDIR enmDir, SHCLSOURCE enmSource, PSHCLTRANSFERCALLBACKS pCallbacks, PSHCLTRANSFER *ppTransfer)
+{
+    return ShClTransferCreateEx(enmDir, enmSource, pCallbacks,
                                 SHCL_TRANSFER_DEFAULT_MAX_CHUNK_SIZE,
                                 SHCL_TRANSFER_DEFAULT_MAX_LIST_HANDLES,
@@ -1469 +1480 @@
  *                              destination callback table will be unset.
  */
-void ShClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst,
-                               PSHCLTRANSFERCALLBACKS pCallbacksSrc)
+static void shClTransferCopyCallbacks(PSHCLTRANSFERCALLBACKS pCallbacksDst, PSHCLTRANSFERCALLBACKS pCallbacksSrc)
 {
     AssertPtrReturnVoid(pCallbacksDst);
+    /* pCallbacksSrc can be NULL */
 
     if (pCallbacksSrc) /* Set */
@@ -1508 +1519 @@
  * @note    Must come before initializing the transfer via ShClTransferInit().
  */
-void ShClTransferSetCallbacks(PSHCLTRANSFER pTransfer,
-                              PSHCLTRANSFERCALLBACKS pCallbacks)
+static void shClTransferSetCallbacks(PSHCLTRANSFER pTransfer, PSHCLTRANSFERCALLBACKS pCallbacks)
 {
     AssertPtrReturnVoid(pTransfer);
     /* pCallbacks can be NULL. */
 
-    ShClTransferCopyCallbacks(&pTransfer->Callbacks, pCallbacks);
+    shClTransferCopyCallbacks(&pTransfer->Callbacks, pCallbacks);
 
     /* Make sure that the callback context has all values set according to the callback table.

trunk/src/VBox/GuestHost/SharedClipboard/testcase/tstClipboardHttpServer.cpp

@@ -212 +212 @@
             {
                 PSHCLTRANSFER pTx;
-                RTTEST_CHECK_RC_OK(hTest, ShClTransferCreate(SHCLTRANSFERDIR_TO_REMOTE, SHCLSOURCE_LOCAL, &pTx));
+                RTTEST_CHECK_RC_OK(hTest, ShClTransferCreate(SHCLTRANSFERDIR_TO_REMOTE, SHCLSOURCE_LOCAL, NULL /* Callbacks */, &pTx));
                 RTTEST_CHECK_RC_OK(hTest, ShClTransferSetProvider(pTx, &Provider));
                 RTTEST_CHECK_RC_OK(hTest, ShClTransferInit(pTx));