tcp.h revision c1d279fc0865b91a40b30eda02ed14f6533fe1a4
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Copyright (C) 2006-2015 Oracle Corporation
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * available from http://www.virtualbox.org. This file is free software;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * The contents of this file may alternatively be used under the terms
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * of the Common Development and Distribution License Version 1.0
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * VirtualBox OSE distribution, in which case the provisions of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * CDDL are applicable instead of those of the GPL.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * You may elect to license modified versions of this file under the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * terms and conditions of either the GPL or the CDDL or both.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync# error "There are no RTFile APIs available Ring-0 Host Context!"
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @defgroup grp_rt_tcp RTTcp - TCP/IP
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @ingroup grp_rt
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Serve a TCP Server connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns VERR_TCP_SERVER_STOP to terminate the server loop forcing
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * the RTTcpCreateServer() call to return.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock The socket which the client is connected to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The call will close this socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvUser User argument.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef DECLCALLBACK(int) FNRTTCPSERVE(RTSOCKET Sock, void *pvUser);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Pointer to a RTTCPSERVE(). */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Create single connection at a time TCP Server in a separate thread.
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * The thread will loop accepting connections and call pfnServe for
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * each of the incoming connections in turn. The pfnServe function can
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * return VERR_TCP_SERVER_STOP too terminate this loop. RTTcpServerDestroy()
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * should be used to terminate the server.
48d60b042893290a747d3abeda71a3085d9133fdvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszAddress The address for creating a listening socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * If NULL or empty string the server is bound to all interfaces.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param uPort The port for creating a listening socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param enmType The thread type.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszThrdName The name of the worker thread.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnServe The function which will serve a new client connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvUser User argument passed to pfnServe.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param ppServer Where to store the serverhandle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerCreate(const char *pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char *pszThrdName,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync PFNRTTCPSERVE pfnServe, void *pvUser, PPRTTCPSERVER ppServer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Create single connection at a time TCP Server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The caller must call RTTcpServerListen() to actually start the server.
10eaaac806009b8336cc5d746fe5072f6c9f58c0vboxsync * @returns iprt status code.
10eaaac806009b8336cc5d746fe5072f6c9f58c0vboxsync * @param pszAddress The address for creating a listening socket.
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * If NULL the server is bound to all interfaces.
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * @param uPort The port for creating a listening socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param ppServer Where to store the serverhandle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerCreateEx(const char *pszAddress, uint32_t uPort, PPRTTCPSERVER ppServer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Closes down and frees a TCP Server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This will also terminate any open connections to the server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pServer Handle to the server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerDestroy(PRTTCPSERVER pServer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Listen for incoming connections.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The function will loop accepting connections and call pfnServe for
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * each of the incoming connections in turn. The pfnServe function can
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * return VERR_TCP_SERVER_STOP too terminate this loop. A stopped server
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * can only be destroyed.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pServer The server handle as returned from RTTcpServerCreateEx().
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfnServe The function which will serve a new client connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvUser User argument passed to pfnServe.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerListen(PRTTCPSERVER pServer, PFNRTTCPSERVE pfnServe, void *pvUser);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Listen and accept one incoming connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This is an alternative to RTTcpServerListen for the use the callbacks are not
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * possible.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_TCP_SERVER_SHUTDOWN if shut down by RTTcpServerShutdown.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_INTERRUPTED if the listening was interrupted.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pServer The server handle as returned from RTTcpServerCreateEx().
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param phClientSocket Where to return the socket handle to the client
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * connection (on success only). This must be closed
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * by calling RTTcpServerDisconnectClient2().
5eca6b757429b1f1d768e16fba65c485af34319dvboxsyncRTR3DECL(int) RTTcpServerListen2(PRTTCPSERVER pServer, PRTSOCKET phClientSocket);
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * Terminate the open connection to the server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pServer Handle to the server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerDisconnectClient(PRTTCPSERVER pServer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Terminates an open client connect when using RTTcpListen2
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param hClientSocket The client socket handle. This will be invalid upon
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * return, whether successful or not. NIL is quietly
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * ignored (VINF_SUCCESS).
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerDisconnectClient2(RTSOCKET hClientSocket);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Shuts down the server, leaving client connections open.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pServer Handle to the server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpServerShutdown(PRTTCPSERVER pServer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Connect (as a client) to a TCP Server.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszAddress The address to connect to.
6565c2fb4f10f47bcb5436630d2dc35e5a4f28e2vboxsync * @param uPort The port to connect to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pSock Where to store the handle to the established connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpClientConnect(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Opaque pointer used by RTTcpClientConnectEx and RTTcpClientCancelConnect. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsynctypedef struct RTTCPCLIENTCONNECTCANCEL *PRTTCPCLIENTCONNECTCANCEL;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Connect (as a client) to a TCP Server, extended version.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pszAddress The address to connect to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param uPort The port to connect to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pSock Where to store the handle to the established connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cMillies Number of milliseconds to wait for the connect attempt to complete.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Use RT_INDEFINITE_WAIT to wait for ever.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Use RT_SOCKETCONNECT_DEFAULT_WAIT to wait for the default time
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * configured on the running system.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param ppCancelCookie Where to store information for canceling the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * operation (from a different thread). Optional.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * The pointer _must_ be initialized to NULL before a
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * series of connection attempts begins, i.e. at a time
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * where there will be no RTTcpClientCancelConnect
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * calls racing access. RTTcpClientCancelConnect will
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * set it to a special non-NULL value that causes the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * current or/and next connect call to fail.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @sa RTTcpClientCancelConnect
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpClientConnectEx(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync RTMSINTERVAL cMillies, PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Cancels a RTTcpClientConnectEx call on a different thread.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param ppCancelCookie The address of the cookie pointer shared with the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * connect call.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsyncRTR3DECL(int) RTTcpClientCancelConnect(PRTTCPCLIENTCONNECTCANCEL volatile *ppCancelCookie);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Close a socket returned by RTTcpClientConnect().
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Close a socket returned by RTTcpClientConnect().
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param hSocket The socket handle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param fGracefulShutdown If true, try do a graceful shutdown of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * outgoing pipe and draining any lingering input.
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsync * This is sometimes better for the server side.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * If false, just close the connection without
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * further ado.
38b70b2dcb1783801f7580cba797a0c8af4b5326vboxsyncRTR3DECL(int) RTTcpClientCloseEx(RTSOCKET Sock, bool fGracefulShutdown);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Receive data from a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvBuffer Where to put the data we read.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbBuffer Read buffer size.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pcbRead Number of bytes read.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * If NULL the entire buffer will be filled upon successful return.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * If not NULL a partial read can be done successfully.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpRead(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * Send data to a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_INTERRUPTED if interrupted before anything was written.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvBuffer Buffer to write data to socket.
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync * @param cbBuffer How much to write.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpWrite(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Flush socket write buffers.
fa92c704624def98d3c4aca86d65182effb98e04vboxsync * @returns iprt status code.
fa92c704624def98d3c4aca86d65182effb98e04vboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Enables or disables delaying sends to coalesce packets.
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync * The TCP/IP stack usually uses the Nagle algorithm (RFC 896) to implement the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * coalescing.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync * @param fEnable When set to true enables coalescing.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpSetSendCoalescing(RTSOCKET Sock, bool fEnable);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Socket I/O multiplexing.
fa92c704624def98d3c4aca86d65182effb98e04vboxsync * Checks if the socket is ready for reading.
fa92c704624def98d3c4aca86d65182effb98e04vboxsync * @returns iprt status code.
fa92c704624def98d3c4aca86d65182effb98e04vboxsync * @param Sock Socket descriptor.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @param cMillies Number of milliseconds to wait for the socket.
17c6e5e8177d068d1bc6af875d1610718efcfdb4vboxsync * Use RT_INDEFINITE_WAIT to wait for ever.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpSelectOne(RTSOCKET Sock, RTMSINTERVAL cMillies);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Socket I/O multiplexing
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Checks if the socket is ready for one of the given events.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param fEvents Event mask to wait for.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Use the RTSOCKET_EVT_* defines.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pfEvents Where to store the event mask on return.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cMillies Number of milliseconds to wait for the socket.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * Use RT_INDEFINITE_WAIT to wait for ever.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpSelectOneEx(RTSOCKET Sock, uint32_t fEvents, uint32_t *pfEvents,
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#if 0 /* skipping these for now - RTTcpServer* handles this. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Listen for connection on a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cBackLog The maximum length the queue of pending connections
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * may grow to.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpListen(RTSOCKET Sock, int cBackLog);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Accept a connection on a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param uPort The port for accepting connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pSockAccepted Where to store the handle to the accepted connection.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpAccept(RTSOCKET Sock, unsigned uPort, PRTSOCKET pSockAccepted);
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * Gets the address of the local side.
5eca6b757429b1f1d768e16fba65c485af34319dvboxsync * @returns IPRT status code.
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * @param Sock Socket descriptor.
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * @param pAddr Where to store the local address on success.
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsyncRTR3DECL(int) RTTcpGetLocalAddress(RTSOCKET Sock, PRTNETADDR pAddr);
5eca6b757429b1f1d768e16fba65c485af34319dvboxsync * Gets the address of the other party.
5eca6b757429b1f1d768e16fba65c485af34319dvboxsync * @returns IPRT status code.
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsync * @param Sock Socket descriptor.
5eca6b757429b1f1d768e16fba65c485af34319dvboxsync * @param pAddr Where to store the peer address on success.
940dbfa4936f2e3966e9e874c4886709f0c75b44vboxsyncRTR3DECL(int) RTTcpGetPeerAddress(RTSOCKET Sock, PRTNETADDR pAddr);
5eca6b757429b1f1d768e16fba65c485af34319dvboxsync * Send data from a scatter/gather buffer to a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_INTERRUPTED if interrupted before anything was written.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pSgBuf Scatter/gather buffer to write data to socket.
ada08ea58e7613c10d4c40669fd4fb955324bfdfvboxsyncRTR3DECL(int) RTTcpSgWrite(RTSOCKET Sock, PCRTSGBUF pSgBuf);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Send data from multiple buffers to a socket.
5cd35366dd244ca8c8c583904fc6ff2a0c60fa0fvboxsync * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * for lazy coders. The "L" in the function name is short for "list" just like
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * in the execl libc API.
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * @returns IPRT status code.
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * @retval VERR_INTERRUPTED if interrupted before anything was written.
2a08e12d5dcc1bb5057a9620e87ad361d41a1c1fvboxsync * @param hSocket The socket handle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cSegs The number of data segments in the following
43d3e60a2bcef646da0887a845e67c3a47759158vboxsync * ellipsis.
48d60b042893290a747d3abeda71a3085d9133fdvboxsync * @param ... Pairs of buffer pointers (void const *) and buffer
48d60b042893290a747d3abeda71a3085d9133fdvboxsync * sizes (size_t). Make 101% sure the pointer is
48d60b042893290a747d3abeda71a3085d9133fdvboxsync * really size_t.
48d60b042893290a747d3abeda71a3085d9133fdvboxsyncRTR3DECL(int) RTTcpSgWriteL(RTSOCKET hSocket, size_t cSegs, ...);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Send data from multiple buffers to a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
5cd35366dd244ca8c8c583904fc6ff2a0c60fa0fvboxsync * for lazy coders. The "L" in the function name is short for "list" just like
43d3e60a2bcef646da0887a845e67c3a47759158vboxsync * in the execl libc API.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_INTERRUPTED if interrupted before anything was written.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param hSocket The socket handle.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @param cSegs The number of data segments in the following
607961fb76ee6b24ca8d3b53ece9d70412f73b1bvboxsync * argument list.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @param va Pairs of buffer pointers (void const *) and buffer
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * sizes (size_t). Make 101% sure the pointer is
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * really size_t.
f20f327b65009074292a4b9ad44a02b6bfb2de8avboxsyncRTR3DECL(int) RTTcpSgWriteLV(RTSOCKET hSocket, size_t cSegs, va_list va);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Receive data from a socket.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * This version doesn't block if there is no data on the socket.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvBuffer Where to put the data we read.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbBuffer Read buffer size.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pcbRead Number of bytes read.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpReadNB(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Send data to a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This version doesn't block if there is not enough room for the message.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @param Sock Socket descriptor.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pvBuffer Buffer to write data to socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cbBuffer How much to write.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pcbWritten Number of bytes written.
f20f327b65009074292a4b9ad44a02b6bfb2de8avboxsyncRTR3DECL(int) RTTcpWriteNB(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer, size_t *pcbWritten);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Send data from a scatter/gather buffer to a socket.
1bc5a31ae6d57c2b4731a23205f3958678b60193vboxsync * This version doesn't block if there is not enough room for the message.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @returns iprt status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @retval VERR_INTERRUPTED if interrupted before anything was written.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param Sock Socket descriptor.
f20f327b65009074292a4b9ad44a02b6bfb2de8avboxsync * @param pSgBuf Scatter/gather buffer to write data to socket.
10eaaac806009b8336cc5d746fe5072f6c9f58c0vboxsync * @param pcbWritten Number of bytes written.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTTcpSgWriteNB(RTSOCKET Sock, PCRTSGBUF pSgBuf, size_t *pcbWritten);
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * Send data from multiple buffers to a socket.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This version doesn't block if there is not enough room for the message.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
f20f327b65009074292a4b9ad44a02b6bfb2de8avboxsync * for lazy coders. The "L" in the function name is short for "list" just like
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * in the execl libc API.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * @param hSocket The socket handle.
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * @param cSegs The number of data segments in the following
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * ellipsis.
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * @param pcbWritten Number of bytes written.
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * @param ... Pairs of buffer pointers (void const *) and buffer
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * sizes (size_t). Make 101% sure the pointer is
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * really size_t.
b0d29fd0a868929a608ff72658aac997cc95319avboxsyncRTR3DECL(int) RTTcpSgWriteLNB(RTSOCKET hSocket, size_t cSegs, size_t *pcbWritten, ...);
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * Send data from multiple buffers to a socket.
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * This version doesn't block if there is not enough room for the message.
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
c50100d1513854735d4e3593b3b385c007f6d8b6vboxsync * for lazy coders. The "L" in the function name is short for "list" just like
b0d29fd0a868929a608ff72658aac997cc95319avboxsync * in the execl libc API.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @returns IPRT status code.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param hSocket The socket handle.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param cSegs The number of data segments in the following
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * argument list.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * @param pcbWritten Number of bytes written.
dee2201f96a012bfb966c8de4ab006c2c90a0eefvboxsync * @param va Pairs of buffer pointers (void const *) and buffer
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * sizes (size_t). Make 101% sure the pointer is
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * really size_t.