Changeset 31103 in vbox for trunk/include/iprt

Timestamp:

Jul 26, 2010 10:58:27 AM (15 years ago)

Author:

vboxsync

Message:

IPRT/Socket: Add non blocking versions of the read/write methods. The mode is switched on demand.

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/socket.h

@@ -226 +226 @@
 RTDECL(int) RTSocketSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
 
+/**
+ * Receive data from a socket.
+ *
+ * This version doesn't block if there is no data on the socket.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   pvBuffer        Where to put the data we read.
+ * @param   cbBuffer        Read buffer size.
+ * @param   pcbRead         Number of bytes read.
+ */
+RTDECL(int) RTSocketReadNB(RTSOCKET hSocket, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
+
+/**
+ * Send data to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   pvBuffer        Buffer to write data to socket.
+ * @param   cbBuffer        How much to write.
+ * @param   pcbWritten      Number of bytes written.
+ */
+RTDECL(int) RTSocketWriteNB(RTSOCKET hSocket, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
+
+/**
+ * Send data from a scatter/gather buffer to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ *
+ * @returns iprt status code.
+ *
+ * @param   Sock        Socket descriptor.
+ * @param   pSgBuf      Scatter/gather buffer to write data to socket.
+ * @param   pcbWritten  Number of bytes written.
+ */
+RTR3DECL(int)  RTSocketSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t *pcbWritten);
+
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   pcbWritten      Number of bytes written.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTSocketSgWriteLNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   pcbWritten      Number of bytes written.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t). Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTSocketSgWriteLVNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, va_list va);
+
 /** @} */
 RT_C_DECLS_END

trunk/include/iprt/tcp.h

@@ -331 +331 @@
 RTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
 
+/**
+ * Receive data from a socket.
+ *
+ * This version doesn't block if there is no data on the socket.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   Sock        Socket descriptor.
+ * @param   pvBuffer    Where to put the data we read.
+ * @param   cbBuffer    Read buffer size.
+ * @param   pcbRead     Number of bytes read.
+ */
+RTR3DECL(int)  RTTcpReadNB(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
+
+/**
+ * Send data to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   Sock        Socket descriptor.
+ * @param   pvBuffer    Buffer to write data to socket.
+ * @param   cbBuffer    How much to write.
+ * @param   pcbWritten  Number of bytes written.
+ */
+RTR3DECL(int)  RTTcpWriteNB(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
+
+/**
+ * Send data from a scatter/gather buffer to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ *
+ * @returns iprt status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   Sock        Socket descriptor.
+ * @param   pSgBuf      Scatter/gather buffer to write data to socket.
+ * @param   pcbWritten  Number of bytes written.
+ */
+RTR3DECL(int)  RTTcpSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t cbWritten);
+
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   pcbWritten      Number of bytes written.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteLNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * This version doesn't block if there is not enough room for the message.
+ * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
+ * for lazy coders.  The "L" in the function name is short for "list" just like
+ * in the execl libc API.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   pcbWritten      Number of bytes written.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t). Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteLVNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, va_list va);
+
 /** @} */
 RT_C_DECLS_END