Changeset 31453 in vbox for trunk/include

Timestamp:

Aug 8, 2010 1:30:35 PM (15 years ago)

Author:

vboxsync

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

64526

Message:

Runtime/poll: Add a method to change the events to poll for without removing and adding the source again

File:

• trunk/include/iprt/poll.h (modified) (6 diffs)

trunk/include/iprt/poll.h

@@ -56 +56 @@
  * @retval  VINF_SUCCESS if an event occured on a handle.  Note that these
  * @retval  VERR_INVALID_HANDLE if @a hPollSet is invalid.
- * @retval  VERR_WRONG_ORDER if another thread is already accessing the set. The
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
  *          user is responsible for ensuring single threaded access.
  * @retval  VERR_TIMEOUT if @a cMillies ellapsed without any events.
@@ -82 +82 @@
  * @retval  VINF_SUCCESS if an event occured on a handle.  Note that these
  * @retval  VERR_INVALID_HANDLE if @a hPollSet is invalid.
- * @retval  VERR_WRONG_ORDER if another thread is already accessing the set. The
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
  *          user is responsible for ensuring single threaded access.
  * @retval  VERR_TIMEOUT if @a cMillies ellapsed without any events.
@@ -121 +121 @@
  *
  * @returns IPRT status code
- * @retval  VERR_WRONG_ORDER if another thread is already accessing the set. The
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
  *          user is responsible for ensuring single threaded access.
  * @retval  VERR_POLL_HANDLE_NOT_POLLABLE if the specified handle is not
@@ -141 +141 @@
  * @returns IPRT status code
  * @retval  VERR_INVALID_HANDLE if @a hPollSet not valid.
- * @retval  VERR_WRONG_ORDER if another thread is already accessing the set. The
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
  *          user is responsible for ensuring single threaded access.
  * @retval  VERR_POLL_HANDLE_ID_NOT_FOUND if @a id doesn't resolve to a valid
@@ -159 +159 @@
  * @retval  VINF_SUCCESS if the handle was found.  @a *pHandle is set.
  * @retval  VERR_INVALID_HANDLE if @a hPollSet is invalid.
- * @retval  VERR_WRONG_ORDER if another thread is already accessing the set. The
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
  *          user is responsible for ensuring single threaded access.
  * @retval  VERR_POLL_HANDLE_ID_NOT_FOUND if there is no handle with that ID.
@@ -178 +178 @@
  */
 RTDECL(uint32_t) RTPollSetGetCount(RTPOLLSET hPollSet);
+
+/**
+ * Modifies the events to poll for for the given id.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INVALID_HANDLE if @a hPollSet not valid.
+ * @retval  VERR_CONCURRENT_ACCESS if another thread is already accessing the set. The
+ *          user is responsible for ensuring single threaded access.
+ * @retval  VERR_POLL_HANDLE_ID_NOT_FOUND if @a id doesn't resolve to a valid
+ *          handle.
+ *
+ * @param   hPollSet            The poll set to modify.
+ * @param   id                  The handle ID to change the events for.
+ * @param   fEvents             Which events to poll for.
+ */
+RTDECL(int) RTPollSetEventsChange(RTPOLLSET hPollSet, uint32_t id, uint32_t fEvents);
 
 /**