Changeset 75824 in vbox for trunk/include/VBox/HostServices

Timestamp:

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

Author:

vboxsync

Message:

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

File:

• trunk/include/VBox/HostServices/GuestControlSvc.h (modified) (3 diffs)

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