Changeset 100566 in vbox

Timestamp:

Jul 13, 2023 6:50:43 PM (19 months ago)

Author:

vboxsync

Message:

Shared Clipboard: Added ShClEventWaitEx() + ShClEventSignalEx() for easier error propagation when waiting for events, plus new error codes VERR_SHCLPB_EVENT_FAILED + VERR_SHCLPB_GUEST_ERROR. bugref:9437

Location:

trunk

Files:

• include/VBox/GuestHost/SharedClipboard.h (modified) (2 diffs)
• include/VBox/err.h (modified) (1 diff)
• src/VBox/GuestHost/SharedClipboard/clipboard-common.cpp (modified) (5 diffs)

trunk/include/VBox/GuestHost/SharedClipboard.h

@@ -189 +189 @@
     /** Payload to this event, optional (NULL). */
     PSHCLEVENTPAYLOAD   pPayload;
+    /** Result code (IPRT-style) to assign. */
+    int                 rc;
 } SHCLEVENT;
 /** Pointer to a shared clipboard event. */
@@ -236 +238 @@
 uint32_t ShClEventRetain(PSHCLEVENT pEvent);
 uint32_t ShClEventRelease(PSHCLEVENT pEvent);
+int ShClEventSignalEx(PSHCLEVENT pEvent, int rc, PSHCLEVENTPAYLOAD pPayload);
 int ShClEventSignal(PSHCLEVENT pEvent, PSHCLEVENTPAYLOAD pPayload);
 int ShClEventWait(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload);
+int ShClEventWaitEx(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, int *pRc, PSHCLEVENTPAYLOAD *ppPayload);
 /** @} */
 

trunk/include/VBox/err.h

@@ -3073 +3073 @@
 /** Shared Clipboard transfer ID not found. */
 #define VERR_SHCLPB_TRANSFER_ID_NOT_FOUND           (-7150)
+/** Shared Clipboard guest error. */
+#define VERR_SHCLPB_GUEST_ERROR                     (-7151)
+/** Shared Clipboard event failed error. */
+#define VERR_SHCLPB_EVENT_FAILED                    (-7152)
 /** @} */
 

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

@@ -457 +457 @@
  *
  * @returns VBox status code.
+ * @retval  VERR_SHCLPB_EVENT_FAILED if the event has a set error code.
  * @param   pEvent              Event to wait for.
  * @param   uTimeoutMs          Timeout (in ms) to wait.
+ * @param   pRc                 Where to return the event rc. Optional and can be NULL.
  * @param   ppPayload           Where to store the (allocated) event payload on success. Needs to be free'd with
  *                              SharedClipboardPayloadFree(). Optional.
  */
-int ShClEventWait(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload)
+int ShClEventWaitEx(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, int *pRc, PSHCLEVENTPAYLOAD *ppPayload)
 {
     AssertPtrReturn(pEvent, VERR_INVALID_POINTER);
@@ -471 +473 @@
     if (RT_SUCCESS(rc))
     {
+        if (RT_FAILURE(pEvent->rc))
+            rc = VERR_SHCLPB_EVENT_FAILED;
+
+        if (pRc)
+            *pRc = pEvent->rc;
+
         if (ppPayload)
         {
@@ -486 +494 @@
 
 /**
+ * Waits for an event to get signalled.
+ *
+ * @returns VBox status code.
+ * @retval  VERR_SHCLPB_EVENT_FAILED if the event has a set error code.
+ * @param   pEvent              Event to wait for.
+ * @param   uTimeoutMs          Timeout (in ms) to wait.
+ * @param   ppPayload           Where to store the (allocated) event payload on success. Needs to be free'd with
+ *                              SharedClipboardPayloadFree(). Optional.
+ */
+int ShClEventWait(PSHCLEVENT pEvent, RTMSINTERVAL uTimeoutMs, PSHCLEVENTPAYLOAD *ppPayload)
+{
+    return ShClEventWaitEx(pEvent, uTimeoutMs, NULL /* pRc */, ppPayload);
+}
+
+/**
  * Retains an event by increasing its reference count.
  *
@@ -527 +550 @@
 
 /**
+ * Signals an event, extended version.
+ *
+ * @returns VBox status code.
+ * @param   pEvent              Event to signal.
+ * @param   rc                  Result code to set.
+ * @param   pPayload            Event payload to associate. Takes ownership on
+ *                              success. Optional.
+ */
+int ShClEventSignalEx(PSHCLEVENT pEvent, int rc, PSHCLEVENTPAYLOAD pPayload)
+{
+    AssertPtrReturn(pEvent, VERR_INVALID_POINTER);
+
+    Assert(pEvent->pPayload == NULL);
+
+    pEvent->rc       = rc;
+    pEvent->pPayload = pPayload;
+
+    int rc2 = RTSemEventMultiSignal(pEvent->hEvtMulSem);
+    if (RT_FAILURE(rc2))
+        pEvent->pPayload = NULL; /* (no race condition if consumer also enters the critical section) */
+
+    LogFlowFuncLeaveRC(rc2);
+    return rc2;
+}
+
+/**
  * Signals an event.
  *
@@ -536 +585 @@
 int ShClEventSignal(PSHCLEVENT pEvent, PSHCLEVENTPAYLOAD pPayload)
 {
-    AssertPtrReturn(pEvent, VERR_INVALID_POINTER);
-
-    Assert(pEvent->pPayload == NULL);
-
-    pEvent->pPayload = pPayload;
-
-    int rc = RTSemEventMultiSignal(pEvent->hEvtMulSem);
-    if (RT_FAILURE(rc))
-        pEvent->pPayload = NULL; /* (no race condition if consumer also enters the critical section) */
-
-    LogFlowFuncLeaveRC(rc);
-    return rc;
+    return ShClEventSignalEx(pEvent, VINF_SUCCESS, pPayload);
 }