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

Timestamp:

Jul 18, 2023 3:59:11 PM (20 months ago)

Author:

vboxsync

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

158470

Message:

Shared Clipboard: Added some more transfer utility functions handy to have. bugref:9437

File:

• trunk/src/VBox/GuestHost/SharedClipboard/clipboard-transfers.cpp (modified) (5 diffs)

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

@@ -1237 +1237 @@
     LogFlowFuncLeaveRC(rc);
     return rc;
+}
+
+/**
+ * Returns whether a transfer is in a running state or not.
+ *
+ * @returns @c true if in running state, or @c false if not.
+ * @param   pTransfer           Clipboard transfer to return status for.
+ */
+bool ShClTransferIsRunning(PSHCLTRANSFER pTransfer)
+{
+    shClTransferLock(pTransfer);
+
+    bool const fRunning = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_STARTED;
+
+    shClTransferUnlock(pTransfer);
+
+    return fRunning;
+}
+
+/**
+ * Returns whether a transfer has been (successfully) completed or not.
+ *
+ * @returns @c true if complete, or @c false if not.
+ * @param   pTransfer           Clipboard transfer to return status for.
+ */
+bool ShClTransferIsComplete(PSHCLTRANSFER pTransfer)
+{
+    shClTransferLock(pTransfer);
+
+    bool const fCompleted = pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_COMPLETED;
+
+    shClTransferUnlock(pTransfer);
+
+    return fCompleted;
+}
+
+/**
+ * Returns whether a transfer has been aborted due to cancelling, killing or an error.
+ *
+ * @returns @c true if in aborted state, or @c false if not.
+ * @param   pTransfer           Clipboard transfer to return status for.
+ */
+bool ShClTransferIsAborted(PSHCLTRANSFER pTransfer)
+{
+    shClTransferLock(pTransfer);
+
+    bool const fAborted =    pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_CANCELED
+                          || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_KILLED
+                          || pTransfer->State.enmStatus == SHCLTRANSFERSTATUS_ERROR;
+
+    shClTransferUnlock(pTransfer);
+
+    return fAborted;
 }
 
@@ -2160 +2213 @@
 }
 
+/**
+ * Completes a transfer (as successful).
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Clipboard transfer to complete.
+ */
 int ShClTransferComplete(PSHCLTRANSFER pTransfer)
 {
@@ -2183 +2242 @@
 }
 
+/**
+ * Cancels or sets an error for a transfer.
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Clipboard transfer to cancel or set error for.
+ * @param   rc                  Error code to set.
+ *                              If set to VERR_CANCELLED, the transfer will be canceled.
+ */
 static int shClTransferCancelOrError(PSHCLTRANSFER pTransfer, int rc)
 {
@@ -2217 +2284 @@
 }
 
+/**
+ * Cancels a transfer.
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Clipboard transfer to cancel.
+ */
 int ShClTransferCancel(PSHCLTRANSFER pTransfer)
 {
@@ -2222 +2295 @@
 }
 
+/**
+ * Kills a transfer.
+ *
+ * Currently cancels it internally.
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Clipboard transfer to kill.
+ */
+int ShClTransferKill(PSHCLTRANSFER pTransfer)
+{
+    return ShClTransferCancel(pTransfer);
+}
+
+/**
+ * Sets an error for a transfer.
+ *
+ * @returns VBox status code.
+ * @param   pTransfer           Clipboard transfer to set error for.
+ * @param   rc                  Error code to set.
+ */
 int ShClTransferError(PSHCLTRANSFER pTransfer, int rc)
 {