Changeset 30270 in vbox for trunk/include/iprt

Timestamp:

Jun 17, 2010 6:56:26 AM (15 years ago)

Author:

vboxsync

Message:

Runtime/tcp+socket: Add function to write to a socket using a scatter/gather buffer

Location:

trunk/include/iprt

Files:

• socket.h (modified) (2 diffs)
• tcp.h (modified) (5 diffs)

trunk/include/iprt/socket.h

@@ -31 +31 @@
 #include <iprt/thread.h>
 #include <iprt/net.h>
+#include <iprt/sg.h>
 
 #ifdef IN_RING0
@@ -176 +177 @@
 RTDECL(int) RTSocketGetPeerAddress(RTSOCKET hSocket, PRTNETADDR pAddr);
 
+/**
+ * Send data from a scatter/gather buffer to a socket.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   pSgBuf          Scatter/gather buffer to write data to socket.
+ */
+RTDECL(int) RTSocketSgWrite(RTSOCKET hSocket, PCRTSGBUF pSgBuf);
+
 /** @} */
 RT_C_DECLS_END

trunk/include/iprt/tcp.h

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2007 Oracle Corporation
+ * Copyright (C) 2006-2010 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -31 +31 @@
 #include <iprt/thread.h>
 #include <iprt/net.h>
+#include <iprt/sg.h>
 
 #ifdef IN_RING0
@@ -216 +217 @@
 
 /**
- * Enables or disable delaying sends to coalesce packets.
+ * Enables or disables delaying sends to coalesce packets.
  *
  * The TCP/IP stack usually uses the Nagle algorithm (RFC 896) to implement the
@@ -223 +224 @@
  * @returns iprt status code.
  * @param   Sock        Socket descriptor.
+ * @param   fEnable     When set to true enables coalescing.
  */
 RTR3DECL(int)  RTTcpSetSendCoalescing(RTSOCKET Sock, bool fEnable);
@@ -279 +281 @@
 RTR3DECL(int) RTTcpGetPeerAddress(RTSOCKET Sock, PRTNETADDR pAddr);
 
+/**
+ * Send data from a scatter/gather buffer to a socket.
+ *
+ * @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.
+ */
+RTR3DECL(int)  RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf);
+
 /** @} */
 RT_C_DECLS_END