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