pipe.h revision 5f076b675789f7dd23040096fa3fdc636bd4ea10
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * IPRT - Anonymous Pipes.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Copyright (C) 2010 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * additional information or have any questions.
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);
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Closes one end of a pipe created by RTPipeCreate.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The pipe end to close.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Gets the native handle for an IPRT pipe handle.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns The native handle.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Read bytes from a pipe, non-blocking.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
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.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pcbRead Where to return the number of bytes that has been
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * read (mandatory).
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.
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.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsyncRTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void *pvBuf, size_t cbToRead);
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Write bytes to a pipe.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * This will block until all bytes are written.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to write to.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param pvBuf What to write.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param cbToWrite How much to write.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsyncRTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite);
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Flushes the buffers for the specified pipe and making sure the other party
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * reads them.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @retval VERR_NOT_SUPPORTED if not supported by the OS?
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT pipe handle to flush.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * Checks if the pipe is ready for reading.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @returns IPRT status code.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param hPipe The IPRT read pipe handle to select on.
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * @param cMillies Number of milliseconds to wait. Use
5f076b675789f7dd23040096fa3fdc636bd4ea10vboxsync * RT_INDEFINITE_WAIT to wait for ever.