5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * IPRT - Anonymous Pipes.
c7814cf6e1240a519cbec0441e033d0e2470ed00vboxsync * Copyright (C) 2010-2011 Oracle Corporation
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * available from http://www.virtualbox.org. This file is free software;
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * you can redistribute it and/or modify it under the terms of the GNU
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * General Public License (GPL) as published by the Free Software
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * The contents of this file may alternatively be used under the terms
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * of the Common Development and Distribution License Version 1.0
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * VirtualBox OSE distribution, in which case the provisions of the
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * CDDL are applicable instead of those of the GPL.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * You may elect to license modified versions of this file under the
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * terms and conditions of either the GPL or the CDDL or both.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync/** @defgroup grp_rt_pipe RTPipe - Anonymous Pipes
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @ingroup grp_rt
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Create an anonymous pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param phPipeRead Where to return the read end of the pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param phPipeWrite Where to return the write end of the pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param fFlags A combination of RTPIPE_C_XXX defines.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsyncRTDECL(int) RTPipeCreate(PRTPIPE phPipeRead, PRTPIPE phPipeWrite, uint32_t fFlags);
14ebfaa1c57c3239ff757d0034253ff19647b276vboxsync/** @name RTPipeCreate flags.
14ebfaa1c57c3239ff757d0034253ff19647b276vboxsync/** Mark the read end as inheritable. */
14ebfaa1c57c3239ff757d0034253ff19647b276vboxsync/** Mark the write end as inheritable. */
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync/** Mask of valid flags. */
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Closes one end of a pipe created by RTPipeCreate.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The pipe end to close.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * Creates an IPRT pipe handle from a native one.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * Do NOT use the native handle after passing it to this function, IPRT owns it
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * and might even have closed in some cases (in order to gain some query
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * information access on Windows).
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * @returns IPRT status code.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * @param phPipe Where to return the pipe handle.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * @param hNativePipe The native pipe handle.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * @param fFlags Pipe flags, RTPIPE_N_XXX.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsyncRTDECL(int) RTPipeFromNative(PRTPIPE phPipe, RTHCINTPTR hNativePipe, uint32_t fFlags);
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync/** @name RTPipeFromNative flags.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync/** The read end. */
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync/** The write end. */
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync/** Make sure the pipe is inheritable if set and not inheritable when clear. */
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync/** Mask of valid flags. */
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Gets the native handle for an IPRT pipe handle.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * This is mainly for passing a pipe to a child and then closing the parent
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * handle. IPRT also uses it internally to implement RTProcCreatEx and
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * RTPollSetAdd on some platforms. Do NOT expect sane API behavior if used
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * for any other purpose.
33698994f509c2b3a92e81a828ee7a0e01b81de0vboxsync * @returns The native handle. -1 on failure.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Read bytes from a pipe, non-blocking.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeReadBlocking.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * all the buffered data.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VINF_TRY_AGAIN if no data was available. @a *pcbRead will be set to
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_ACCESS_DENIED if it's a write pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to read from.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pvBuf Where to put the bytes we read.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @param cbToRead How much to read. Must be greater than 0.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pcbRead Where to return the number of bytes that has been
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * read (mandatory). This is 0 if there is no more
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * bytes to read.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @sa RTPipeReadBlocking.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsyncRTDECL(int) RTPipeRead(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Read bytes from a pipe, blocking.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeRead.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * all the buffered data.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_ACCESS_DENIED if it's a write pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to read from.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pvBuf Where to put the bytes we read.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param cbToRead How much to read.
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsync * @param pcbRead Where to return the number of bytes that has been
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsync * read. Optional.
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsyncRTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * Write bytes to a pipe, non-blocking.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @returns IPRT status code.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeWriteBlocking.
45c4c3d2db1a166b7b1e92960adb823960821386vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
45c4c3d2db1a166b7b1e92960adb823960821386vboxsync * trigger when @a cbToWrite is 0.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VINF_TRY_AGAIN if no data was written. @a *pcbWritten will be set
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @param hPipe The IPRT pipe handle to write to.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @param pvBuf What to write.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @param cbToWrite How much to write.
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsync * @param pcbWritten How many bytes we wrote, mandatory. The return can
7dfb99974324af3e0dbbae9902d016927e113925vboxsyncRTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * Write bytes to a pipe, blocking.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
7dfb99974324af3e0dbbae9902d016927e113925vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeWrite.
45c4c3d2db1a166b7b1e92960adb823960821386vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
45c4c3d2db1a166b7b1e92960adb823960821386vboxsync * trigger when @a cbToWrite is 0.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to write to.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pvBuf What to write.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param cbToWrite How much to write.
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsync * @param pcbWritten How many bytes we wrote, optional. If NULL then all
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsync * bytes will be written.
b1d7d513c459787311cd09c440524044fa7ff8a9vboxsyncRTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Flushes the buffers for the specified pipe and making sure the other party
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * reads them.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to flush.
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * Checks if the pipe is ready for reading or writing (depending on the pipe
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
63eef6302c849883ea6a8e3ebef4b7173e3245e9vboxsync * @retval VERR_TIMEOUT if the timeout was reached before the pipe was ready
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS?
b41f65ee355ae1d4b24473c6d6d70c653497429avboxsync * @param hPipe The IPRT pipe handle to select on.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param cMillies Number of milliseconds to wait. Use
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * RT_INDEFINITE_WAIT to wait for ever.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsyncRTDECL(int) RTPipeSelectOne(RTPIPE hPipe, RTMSINTERVAL cMillies);
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * Queries the number of bytes immediately available for reading.
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * @returns IPRT status code.
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS. The caller shall
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * handle this case.
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * @param hPipe The IPRT read pipe handle.
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * @param pcbReadable Where to return the number of bytes that is ready
1729795f504cc1975ec195bca8b493c2faa0f5ddvboxsync * to be read.