pipe.h revision 63eef6302c849883ea6a8e3ebef4b7173e3245e9
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * IPRT - Anonymous Pipes.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Copyright (C) 2010 Sun Microsystems, Inc.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * available from http://www.virtualbox.org. This file is free software;
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * you can redistribute it and/or modify it under the terms of the GNU
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * General Public License (GPL) as published by the Free Software
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * The contents of this file may alternatively be used under the terms
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * of the Common Development and Distribution License Version 1.0
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * VirtualBox OSE distribution, in which case the provisions of the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * CDDL are applicable instead of those of the GPL.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * You may elect to license modified versions of this file under the
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * terms and conditions of either the GPL or the CDDL or both.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * additional information or have any questions.
174e1d5b2d6b6d7c92271d7fcc070c6d0cc92312vboxsync/** @defgroup grp_rt_pipe RTPipe - Anonymous Pipes
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @ingroup grp_rt
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Create an anonymous pipe.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param phPipeRead Where to return the read end of the pipe.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param phPipeWrite Where to return the write end of the pipe.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param fFlags A combination of RTPIPE_C_XXX defines.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncRTDECL(int) RTPipeCreate(PRTPIPE phPipeRead, PRTPIPE phPipeWrite, uint32_t fFlags);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** @name RTPipeCreate flags.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Mark the read end as inheritable. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Mark the write end as inheritable. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync/** Mask of valid flags. */
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Closes one end of a pipe created by RTPipeCreate.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param hPipe The pipe end to close.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Gets the native handle for an IPRT pipe handle.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns The native handle.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param hPipe The IPRT pipe handle.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Read bytes from a pipe, non-blocking.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeReadBlocking.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * all the buffered data.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VINF_TRY_AGAIN if no data was available. @a *pcbRead will be set to
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_ACCESS_DENIED if it's a write pipe.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param hPipe The IPRT pipe handle to read from.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param pvBuf Where to put the bytes we read.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param cbToRead How much to read. Must be greater than 0.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param pcbRead Where to return the number of bytes that has been
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync * read (mandatory). This is 0 if there is no more
b379286f0d2c8d82f5a575eb907c7476aa6ae84bvboxsync * bytes to read.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @sa RTPipeReadBlocking.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsyncRTDECL(int) RTPipeRead(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Read bytes from a pipe, blocking.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeRead.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * all the buffered data.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_ACCESS_DENIED if it's a write pipe.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param hPipe The IPRT pipe handle to read from.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param pvBuf Where to put the bytes we read.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param cbToRead How much to read.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @param pcbRead Where to return the number of bytes that has been
9474d83dcac691984017f8255821b95ec7642804vboxsync * read. Optional.
9474d83dcac691984017f8255821b95ec7642804vboxsyncRTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
9474d83dcac691984017f8255821b95ec7642804vboxsync * Write bytes to a pipe, non-blocking.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @returns IPRT status code.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeWriteBlocking.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
9474d83dcac691984017f8255821b95ec7642804vboxsync * trigger when @a cbToWrite is 0.
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VINF_TRY_AGAIN if no data was written. @a *pcbWritten will be set
9474d83dcac691984017f8255821b95ec7642804vboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @param hPipe The IPRT pipe handle to write to.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @param pvBuf What to write.
666e2c9af6a34f7a05d8069a11194756312f5be6vboxsync * @param cbToWrite How much to write.
666e2c9af6a34f7a05d8069a11194756312f5be6vboxsync * @param pcbWritten How many bytes we wrote, mandatory. The return can
97566036db1dc1dba46ed21be4e147c728fd1027vboxsyncRTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * Write bytes to a pipe, blocking.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @returns IPRT status code.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @retval VERR_WRONG_ORDER if racing a call to RTPipeWrite.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * trigger when @a cbToWrite is 0.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @param hPipe The IPRT pipe handle to write to.
97566036db1dc1dba46ed21be4e147c728fd1027vboxsync * @param pvBuf What to write.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param cbToWrite How much to write.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param pcbWritten How many bytes we wrote, optional. If NULL then all
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * bytes will be written.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsyncRTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Flushes the buffers for the specified pipe and making sure the other party
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * reads them.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_BROKEN_PIPE if the remote party has disconnected.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_ACCESS_DENIED if it's a read pipe.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param hPipe The IPRT pipe handle to flush.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * Checks if the pipe is ready for reading or writing (depending on the pipe
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @returns IPRT status code.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_TIMEOUT if the timeout was reached before the pipe was ready
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS?
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * @param hPipe The IPRT pipe handle to select on.
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * @param cMillies Number of milliseconds to wait. Use
9cabb72c6d6feb65e839ce50765643b98bb9a301vboxsync * RT_INDEFINITE_WAIT to wait for ever.