socket.h revision 4bd3e7685494afe7c303fc131c66e685023b6b4a
/** @file
* IPRT - Network Sockets.
*/
/*
* Copyright (C) 2006-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_socket_h
#define ___iprt_socket_h
#ifdef IN_RING0
# error "There are no RTSocket APIs available Ring-0 Host Context!"
#endif
/** @defgroup grp_rt_tcp RTSocket - Network Sockets
* @ingroup grp_rt
* @{
*/
/**
* Retains a reference to the socket handle.
*
* @returns New reference count, UINT32_MAX on invalid handle (asserted).
*
* @param hSocket The socket handle.
*/
/**
* Release a reference to the socket handle.
*
* When the reference count reaches zero, the socket handle is shut down and
* destroyed. This will not be graceful shutdown, use the protocol specific
* close method if this is desired.
*
* @returns New reference count, UINT32_MAX on invalid handle (asserted).
*
* @param hSocket The socket handle. The NIL handle is quietly
* ignored and 0 is returned.
*/
/**
* Shuts down the socket, close it and then release one handle reference.
*
* This is slightly different from RTSocketRelease which will first do the
* shutting down and closing when the reference count reaches zero.
*
* @returns IPRT status code.
* @param hSocket The socket handle. NIL is ignored.
*
* @remarks This will not perform a graceful shutdown of the socket, it will
* just destroy it. Use the protocol specific close method if this is
* desired.
*/
/**
* Creates an IPRT socket 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 upon a successful return.
*
* @returns IPRT status code.
* @param phSocket Where to store the IPRT socket handle.
* @param uNative The native handle.
*/
/**
* Gets the native socket handle.
*
* @returns The native socket handle or RTHCUINTPTR_MAX if not invalid.
* @param hSocket The socket handle.
*/
/**
* Helper that ensures the correct inheritability of a socket.
*
* We're currently ignoring failures.
*
* @returns IPRT status code
* @param hSocket The socket handle.
* @param fInheritable The desired inheritability state.
*/
/**
* Receive data from a socket.
*
* @returns IPRT status code.
* @param hSocket The socket handle.
* @param pvBuffer Where to put the data we read.
* @param cbBuffer Read buffer size.
* @param pcbRead Number of bytes read. If NULL the entire buffer
* will be filled upon successful return. If not NULL a
* partial read can be done successfully.
*/
/**
* Send data to a socket.
*
* @returns IPRT status code.
* @retval VERR_INTERRUPTED if interrupted before anything was written.
*
* @param hSocket The socket handle.
* @param pvBuffer Buffer to write data to socket.
* @param cbBuffer How much to write.
*/
/**
* Checks if the socket is ready for reading (for I/O multiplexing).
*
* @returns IPRT status code.
* @param hSocket The socket handle.
* @param cMillies Number of milliseconds to wait for the socket. Use
* RT_INDEFINITE_WAIT to wait for ever.
*/
/**
* Shuts down one or both directions of communciation.
*
* @returns IPRT status code.
* @param hSocket The socket handle.
* @param fRead Whether to shutdown our read direction.
* @param fWrite Whether to shutdown our write direction.
*/
/**
* Gets the address of the local side.
*
* @returns IPRT status code.
* @param Sock Socket descriptor.
* @param pAddr Where to store the local address on success.
*/
/**
* Gets the address of the other party.
*
* @returns IPRT status code.
* @param Sock Socket descriptor.
* @param pAddr Where to store the peer address on success.
*/
/**
*
* @returns IPRT status code.
* @retval VERR_INTERRUPTED if interrupted before anything was written.
*
* @param hSocket The socket handle.
*/
/**
* Send data from multiple buffers to a socket.
*
* This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
* for lazy coders. The "L" in the function name is short for "list" just like
* in the execl libc API.
*
* @returns IPRT status code.
* @retval VERR_INTERRUPTED if interrupted before anything was written.
*
* @param hSocket The socket handle.
* @param cSegs The number of data segments in the following
* ellipsis.
* @param ... Pairs of buffer pointers (void const *) and buffer
* sizes (size_t). Make 101% sure the pointer is
* really size_t.
*/
/**
* Send data from multiple buffers to a socket.
*
* This is convenience wrapper around the RTSocketSgWrite and RTSgBufInit calls
* for lazy coders. The "L" in the function name is short for "list" just like
* in the execl libc API.
*
* @returns IPRT status code.
* @retval VERR_INTERRUPTED if interrupted before anything was written.
*
* @param hSocket The socket handle.
* @param cSegs The number of data segments in the following
* argument list.
* @param va Pairs of buffer pointers (void const *) and buffer
* sizes (size_t). Make 101% sure the pointer is
* really size_t.
*/
/** @} */
#endif