Changeset 67798 in vbox

Timestamp:

Jul 5, 2017 2:06:40 PM (8 years ago)

Author:

vboxsync

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

116720

Message:

bugref:8524: Additions/linux: play nicely with distribution-installed Additions
Update the documentation of VBOXGUEST_IOCTL_CANCEL_ALL_WAITEVENTS

This change updates the documentation of VBOXGUEST_IOCTL_CANCEL_ALL_WAITEVENTS
to reflect the fact that inside a given VBoxGuest session, calls to
VBOXGUEST_IOCTL_WAITEVENT after a call to CANCEL_ALL_WAITEVENTS are not
allowed, and may be actively blocked at some future point.

Location:

trunk

Files:

• include/VBox/VBoxGuest.h (modified) (1 diff)
• src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibEvent.cpp (modified) (1 diff)

trunk/include/VBox/VBoxGuest.h

@@ -287 +287 @@
 /** IOCTL to VBoxGuest to interrupt (cancel) any pending WAITEVENTs and return.
  * Handled inside the guest additions and not seen by the host at all.
+ * After calling this, VBOXGUEST_IOCTL_WAITEVENT should no longer be called in
+ * the same session.  At the time of writing this is not enforced; at the time
+ * of reading it may be.
  * @see VBOXGUEST_IOCTL_WAITEVENT */
 #define VBOXGUEST_IOCTL_CANCEL_ALL_WAITEVENTS       VBOXGUEST_IOCTL_CODE_(5, 0)

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibEvent.cpp

@@ -87 +87 @@
  *
  * Can be used in combination with a termination flag variable for interrupting
- * event loops.  Avoiding race conditions is the responsibility of the caller.
+ * event loops.  After calling this, VBOXGUEST_IOCTL_WAITEVENT should no longer
+ * be called in the same session.  At the time of writing this is not enforced;
+ * at the time of reading it may be.
  *
  * @returns IPRT status code.