Changeset 30468 in vbox for trunk/include/iprt

Timestamp:

Jun 28, 2010 1:58:04 PM (15 years ago)

Author:

vboxsync

Message:

IPRT:

• Corrected RTSGBUF member names.
• Corrected RTSgBufInit parameter names.
• Don't use AssertReturnVoid (and variations) in RTSgBuf* as there the result is that we use uninitialized structures. Better to crash and burn in IPRT then.
• Added RTSocketSgWriteL/LV and RTTcpSgWriteL/LV for lazy guys like me.
• RTSocketSgWrite doesn't need a do {} while (0).

Location:

trunk/include/iprt

Files:

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

trunk/include/iprt/sg.h

@@ -56 +56 @@
 {
     /** Pointer to the scatter/gather array. */
-    PCRTSGSEG pcaSeg;
+    PCRTSGSEG paSegs;
     /** Number of segments. */
-    unsigned  cSeg;
+    unsigned  cSegs;
     /** Current segment we are in. */
     unsigned  idxSeg;
     /** Pointer to the current segment start. */
-    void     *pvSegCurr;
+    void     *pvSegCur;
     /** Number of bytes left in the current buffer. */
     size_t    cbSegLeft;
@@ -78 +78 @@
  * @returns nothing.
  * @param   pSgBuf    Pointer to the S/G buffer to initialize.
- * @param   pcaSeg    Pointer to the start of the segment array.
- * @param   cSeg      Number of segments in the array.
- */
-RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG pcaSeg, unsigned cSeg);
+ * @param   paSegs    Pointer to the start of the segment array.
+ * @param   cSegs     Number of segments in the array.
+ */
+RTDECL(void) RTSgBufInit(PRTSGBUF pSgBuf, PCRTSGSEG paSegs, unsigned cSegs);
 
 /**

trunk/include/iprt/socket.h

@@ -188 +188 @@
 RTDECL(int) RTSocketSgWrite(RTSOCKET hSocket, PCRTSGBUF pSgBuf);
 
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * 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.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTDECL(int) RTSocketSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * 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.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTDECL(int) RTSocketSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
+
 /** @} */
 RT_C_DECLS_END

trunk/include/iprt/tcp.h

@@ -292 +292 @@
 RTR3DECL(int)  RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf);
 
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * 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.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          ellipsis.
+ * @param   ...             Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t).  Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
+
+/**
+ * Send data from multiple buffers to a socket.
+ *
+ * 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.
+ * @retval  VERR_INTERRUPTED if interrupted before anything was written.
+ *
+ * @param   hSocket         The socket handle.
+ * @param   cSegs           The number of data segments in the following
+ *                          argument list.
+ * @param   va              Pairs of buffer pointers (void const *) and buffer
+ *                          sizes (size_t). Make 101% sure the pointer is
+ *                          really size_t.
+ */
+RTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
+
 /** @} */
 RT_C_DECLS_END