Changeset 26755 in vbox for trunk/include/iprt/pipe.h

Timestamp:

Feb 24, 2010 5:02:09 PM (15 years ago)

Author:

vboxsync

Message:

iprt/pipe.h: Need RTPipeWriteBlocking, some spec adjustments.

File:

• trunk/include/iprt/pipe.h (modified) (3 diffs)

trunk/include/iprt/pipe.h

@@ -79 +79 @@
  *
  * @returns IPRT status code.
+ * @retval  VERR_WRONG_ORDER if racing a call to RTPipeReadBlocking.
+ *
  * @param   hPipe           The IPRT pipe handle to read from.
  * @param   pvBuf           Where to put the bytes we read.
- * @param   cbToRead        How much to read.
+ * @param   cbToRead        How much to read.  Must be greater than 0.
  * @param   pcbRead         Where to return the number of bytes that has been
- *                          read (mandatory).
+ *                          read (mandatory).  This is 0 if there is no more
+ *                          bytes to read.
  * @sa      RTPipeReadBlocking.
  */
@@ -92 +95 @@
  *
  * @returns IPRT status code.
+ * @retval  VERR_WRONG_ORDER if racing a call to RTPipeRead.
+ *
  * @param   hPipe           The IPRT pipe handle to read from.
  * @param   pvBuf           Where to put the bytes we read.
@@ -99 +104 @@
 
 /**
- * Write bytes to a pipe.
- *
- * This will block until all bytes are written.
+ * Write bytes to a pipe, non-blocking.
  *
  * @returns IPRT status code.
+ * @retval  VERR_WRONG_ORDER if racing a call to RTPipeWriteBlocking.
+ *
+ * @param   hPipe           The IPRT pipe handle to write to.
+ * @param   pvBuf           What to write.
+ * @param   cbToWrite       How much to write.
+ * @param   pcbWritten      How many bytes we wrote.
+ */
+RTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
+
+/**
+ * Write bytes to a pipe, blocking.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_WRONG_ORDER if racing a call to RTPipeWrite.
+ *
  * @param   hPipe           The IPRT pipe handle to write to.
  * @param   pvBuf           What to write.
  * @param   cbToWrite       How much to write.
  */
-RTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite);
+RTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite);
 
 /**