Changeset 75824 in vbox for trunk/include

Timestamp:

Nov 29, 2018 10:12:53 PM (6 years ago)

Author:

vboxsync

Message:

VBoxGuestControl: Optimizing message handling - part 4. bugref:9313

Location:

trunk/include/VBox

Files:

• GuestHost/GuestControl.h (modified) (2 diffs)
• HostServices/GuestControlSvc.h (modified) (3 diffs)
• VBoxGuestLib.h (modified) (2 diffs)

trunk/include/VBox/GuestHost/GuestControl.h

@@ -2 +2 @@
 /** @file
  * Guest Control - Common Guest and Host Code.
+ *
+ * @todo r=bird: Just merge this with GuestControlSvc.h!
  */
 
@@ -124 +126 @@
 #define PATHRENAME_FLAG_NO_SYMLINKS         RT_BIT(1)
 /** Mask of valid flags. */
-#define PATHRENAME_FLAG_VALID_MASK          UINT32_C(0x00000002)
+#define PATHRENAME_FLAG_VALID_MASK          UINT32_C(0x00000003)
 /** @} */
 

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -153 +153 @@
      * Gets the current status of a running process, e.g.
      * new data on stdout/stderr, process terminated etc.
-     ** Note: Legacy (VBox < 4.3) command.
+     * @note Legacy (VBox < 4.3) command.
      */
     HOST_EXEC_GET_OUTPUT = 102,
@@ -371 +371 @@
     /** Skip message.
      *
-     * This skips the current message, replying to the sender with
-     * VERR_NOT_SUPPORTED if appropriate.  No parameters.
+     * This skips the current message, replying to the main backend as best it can.
+     * Takes between zero and two parameters.  The first parameter is the 32-bit
+     * VBox status code to pass onto Main when skipping the command, defaults to
+     * VERR_NOT_SUPPORTED.  The second parameter is the 32-bit message ID of the
+     * command to skip, by default whatever is first in the queue is removed.  This
+     * is also the case if UINT32_MAX is specified.
      *
      * @retval  VINF_SUCCESS on success.
      * @retval  VERR_NOT_FOUND if no message pending.
+     * @retval  VERR_MISMATCH if the specified message ID didn't match.
      * @retval  VERR_INVALID_CLIENT_ID
      * @retval  VERR_WRONG_PARAMETER_COUNT
@@ -615 +620 @@
 
 /**
- * Guest file seeking types. Has to
- * match FileSeekType in Main.
+ * Guest file seeking types. Has to match FileSeekType in Main.
+ *
+ * @note This is not compatible with RTFileSeek, which is an unncessary pain.
  */
 enum GUEST_FILE_SEEKTYPE

trunk/include/VBox/VBoxGuestLib.h

@@ -752 +752 @@
      *        Use a union for the HGCM stuff then. */
 
-    /** IN: HGCM client ID to use for
-     *      communication. */
+    /** IN: HGCM client ID to use for communication. */
     uint32_t uClientID;
-    /** IN/OUT: Context ID to retrieve
-     *          or to use. */
+    /** IN/OUT: Context ID to retrieve or to use. */
     uint32_t uContextID;
     /** IN: Protocol version to use. */
@@ -773 +771 @@
 VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx, int rc, uint32_t uType,
                                           void *pvPayload, uint32_t cbPayload);
-VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient);
+VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg);
 VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t uClientId);
 VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t *pidMsg, uint32_t *pcParameters);