localipc.h

/** @file * IPRT - TCP/IP. *//* * Copyright (C) 2006-2007 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * 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. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */#ifndef ___iprt_tcp_h#define ___iprt_tcp_h#include <iprt/cdefs.h>#include <iprt/types.h>#include <iprt/thread.h>#ifdef IN_RING0# error "There are no RTFile APIs available Ring-0 Host Context!"#endif__BEGIN_DECLS/** @defgroup grp_rt_localipc RTLocalIpc - Local IPC * @ingroup grp_rt * @{ *//** Handle to a local IPC server instance. */00050typedefstruct RTLOCALIPCSERVERINT *RTLOCALIPCSERVER;/** Pointer to a local IPC server handle. */00052typedef RTLOCALIPCSERVER *PRTLOCALIPCSERVER;/** Local IPC server handle nil value. */00054#define NIL_RTLOCALIPCSERVER ((RTLOCALIPCSERVER)0)/** Handle to a local ICP session instance. */00057typedefstruct RTLOCALIPCSESSIONINT *RTLOCALIPCSESSION;/** Pointer to a local ICP session handle. */00059typedef RTLOCALIPCSESSION *PRTLOCALIPCSESSION;/** Local ICP session handle nil value. */00061#define NIL_RTLOCALIPCSESSION ((RTLOCALIPCSESSION)0)/** * Create a local IPC server. * * @returns IPRT status code. * @retval VINF_SUCCESS on success and *phServer containg the instance handle. * * @param phServer Where to put the server instance handle. * @param pszName The servier name. This must be unique and not * include any special chars or slashes. It will * be morphed into a unique platform specific * identifier. * @param fFlags Flags, see RTLOCALIPC_FLAGS_*. */RTDECL(int) RTLocalIpcServerCreate(PRTLOCALIPCSERVER phServer, const char *pszName, uint32_t fFlags);
/** @name RTLocalIpcServerCreate flags * @{ *//** The server can handle multiple session. */00083#define RTLOCALIPC_FLAGS_MULTI_SESSION RT_BIT_32(0)/** The mask of valid flags. */00085#define RTLOCALIPC_FLAGS_VALID_MASK UINT32_C(0x00000001)/** @} *//** * Destroys a local IPC server. * * @returns IPRT status code. * * @param hServer The server handle. The nil value is quietly ignored (VINF_SUCCESS). */RTDECL(int) RTLocalIpcServerDestroy(RTLOCALIPCSERVER hServer);
/** * Listen for clients. * * @returns IPRT status code. * @retval VINF_SUCCESS on success and *phClientSession containing the session handle. * @retval VERR_CANCELLED if the listening was interrupted by RTLocalIpcServerCancel(). * * @param hServer The server handle. * @param phClientSession Where to store the client session handle on success. * */RTDECL(int) RTLocalIpcServerListen(RTLOCALIPCSERVER hServer, PRTLOCALIPCSESSION phClientSession);
/** * Cancel the current or subsequent RTLocalIpcServerListen call. * * @returns IPRT status code. * @param hServer The server handle. The nil value is quietly ignored (VINF_SUCCESS). */RTDECL(int) RTLocalIpcServerCancel(RTLOCALIPCSERVER hServer);
/** * Connects to a local IPC server. * * This is used a client process (or thread). * * @returns IPRT status code. * @param VINF_SUCCESS on success and *phSession holding the session handle. * * @param phSession Where to store the sesson handle on success. * @param pszName The server name (see RTLocalIpcServerCreate for details). * @param fFlags Flags. Current undefined, pass 0. */RTDECL(int) RTLocalIpcSessionConnect(PRTLOCALIPCSESSION phSession, const char *pszName, uint32_t fFlags);
/** * Closes the local IPC session. * * This can be used with sessions created by both RTLocalIpcSessionConnect * and RTLocalIpcServerListen. * * @returns IPRT status code. * * @param hSession The session handle. The nil value is quietly ignored (VINF_SUCCESS). */RTDECL(int) RTLocalIpcSessionClose(RTLOCALIPCSESSION hSession);
/** * Receive data from the other end of an local IPC session. * * This will block if there isn't any data. * * @returns IPRT status code. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * * @param hSession The session handle. * @param pvBuffer Where to store the data. * @param cbBuffer If pcbRead is non-NULL this indicates the maximum number of * bytes to read. If pcbRead is NULL the this is the exact number * of bytes to read. * @param pcbRead Optional argument for indicating a partial read and returning * the number of bytes actually read. * This may return 0 on some implementations? */RTDECL(int) RTLocalIpcSessionRead(RTLOCALIPCSESSION hSession, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
/** * Send data to the other end of an local IPC session. * * This may or may not block until the data is received by the other party, * this is an implementation detail. If you want to make sure that the data * has been received you should allways call RTLocalIpcSessionFlush(). * * @returns IPRT status code. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * * @param hSession The session handle. * @param pvBuffer The data to write. * @param cbBuffer The number of bytes to write. */RTDECL(int) RTLocalIpcSessionWrite(RTLOCALIPCSESSION hSession, const void *pvBuffer, size_t cbBuffer);
/** * Flush any buffered data and (perhaps) wait for the other party to receive it. * * The waiting for the other party to receive the data is * implementation dependent. * * @returns IPRT status code. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * * @param hSession The session handle. */RTDECL(int) RTLocalIpcSessionFlush(RTLOCALIPCSESSION hSession);
/** * Wait for data to become read for reading or for the * session to be disconnected. * * @returns IPRT status code. * @retval VINF_SUCCESS when there is data to read. * @retval VERR_TIMEOUT if no data became available within the specified period (@a cMillies) * @retval VERR_BROKEN_PIPE if the session was disconnected. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * * @param hSession The session handle. * @param cMillies The number of milliseconds to wait. Use RT_INDEFINITE_WAIT * to wait forever. * * @remark VERR_INTERRUPTED will not be returned. If this is desired at some later point * add a RTLocalIpcSessionWaitForDataNoResume() variant like we're using elsewhere. */RTDECL(int) RTLocalIpcSessionWaitForData(RTLOCALIPCSESSION hSession, uint32_t cMillies);
/** * Cancells a pending or subsequent operation. * * Not all methods are cancellable, only those which are specfied * returning VERR_CANCELLED. The others are assumed to not be blocking * for ever and ever. * * @returns IPRT status code. * * @param hSession The session handle. */RTDECL(int) RTLocalIpcSessionCancel(RTLOCALIPCSESSION hSession);
/** * Query the process ID of the other party. * * This is an optional feature which may not be implemented, so don't * depend on it and check for VERR_NOT_SUPPORTED. * * @returns IPRT status code. * @retval VINF_SUCCESS and *pProcess on success. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * @retval VERR_NOT_SUPPORTED and *pProcess = NIL_RTPROCESS if not supported. * * @param hSession The session handle. * @param pProcess Where to store the process ID. */RTDECL(int) RTLocalIpcSessionQueryProcess(RTLOCALIPCSESSION hSession, PRTPROCESS pProcess);
/** * Query the user ID of the other party. * * This is an optional feature which may not be implemented, so don't * depend on it and check for VERR_NOT_SUPPORTED. * * @returns IPRT status code. * @retval VINF_SUCCESS and *pUid on success. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * @retval VERR_NOT_SUPPORTED and *pUid = NIL_RTUID if not supported. * * @param hSession The session handle. * @param pUid Where to store the user ID on success. */RTDECL(int) RTLocalIpcSessionQueryUserId(RTLOCALIPCSESSION hSession, PRTUID pUid);
/** * Query the group ID of the other party. * * This is an optional feature which may not be implemented, so don't * depend on it and check for VERR_NOT_SUPPORTED. * * @returns IPRT status code. * @retval VINF_SUCCESS and *pUid on success. * @retval VERR_CANCELLED if the operation was cancelled by RTLocalIpcSessionCancel. * @retval VERR_NOT_SUPPORTED and *pGid = NIL_RTUID if not supported. * * @param hSession The session handle. * @param pGid Where to store the group ID on success. */RTDECL(int) RTLocalIpcSessionQueryGroupId(RTLOCALIPCSESSION hSession, PRTUID pUid);
/** @} */__END_DECLS#endif