Changeset 32276 in vbox for trunk/include

Timestamp:

Sep 7, 2010 11:33:52 AM (14 years ago)

Author:

vboxsync

Message:

IPRT/Socket: Add extended select API where the events to wait for can be provided

Location:

trunk/include/iprt

Files:

• socket.h (modified) (1 diff)
• tcp.h (modified) (2 diffs)

trunk/include/iprt/socket.h

@@ -149 +149 @@
 RTDECL(int) RTSocketSelectOne(RTSOCKET hSocket, RTMSINTERVAL cMillies);
 
+/** @name Select events
+ * @{ */
+/** Readable without blocking. */
+#define RTSOCKET_EVT_READ         RT_BIT_32(0)
+/** Writable without blocking. */
+#define RTSOCKET_EVT_WRITE        RT_BIT_32(1)
+/** Error condition, hangup, exception or similar. */
+#define RTSOCKET_EVT_ERROR        RT_BIT_32(2)
+/** Mask of the valid bits. */
+#define RTSOCKET_EVT_VALID_MASK   UINT32_C(0x00000007)
+/** @} */
+
+/**
+ * Socket I/O multiplexing
+ * Checks if the socket is ready for one of the given events.
+ *
+ * @returns iprt status code.
+ * @param   Sock        Socket descriptor.
+ * @param   fEvents     Event mask to wait for.
+ * @param   pfEvents    Where to store the event mask on return.
+ * @param   cMillies    Number of milliseconds to wait for the socket.
+ *                      Use RT_INDEFINITE_WAIT to wait for ever.
+ */
+RTR3DECL(int)  RTSocketSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
+                                   RTMSINTERVAL cMillies);
+
 /**
  * Shuts down one or both directions of communciation.

trunk/include/iprt/tcp.h

@@ -32 +32 @@
 #include <iprt/net.h>
 #include <iprt/sg.h>
+#include <iprt/socket.h>
 
 #ifdef IN_RING0
@@ -234 +235 @@
 RTR3DECL(int)  RTTcpSelectOne(RTSOCKET Sock, RTMSINTERVAL cMillies);
 
+/**
+ * Socket I/O multiplexing
+ * Checks if the socket is ready for one of the given events.
+ *
+ * @returns iprt status code.
+ * @param   Sock        Socket descriptor.
+ * @param   fEvents     Event mask to wait for.
+ *                      Use the RTSOCKET_EVT_* defines.
+ * @param   pfEvents    Where to store the event mask on return.
+ * @param   cMillies    Number of milliseconds to wait for the socket.
+ *                      Use RT_INDEFINITE_WAIT to wait for ever.
+ */
+RTR3DECL(int)  RTTcpSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
+                                RTMSINTERVAL cMillies);
 
 #if 0 /* skipping these for now - RTTcpServer* handles this. */