udp.h revision 8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1
/** @file
*/
/*
* Copyright (C) 2006-2011 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_udp_h
#define ___iprt_udp_h
#ifdef IN_RING0
# error "There are no RTFile APIs available Ring-0 Host Context!"
#endif
* @ingroup grp_rt
* @{
*/
/**
* Handle incoming UDP datagrams.
*
* @returns iprt status code.
* @returns VERR_UDP_SERVER_STOP to terminate the server loop forcing
* the RTUdpCreateServer() call to return.
* @param Sock The socket on which the datagram needs to be received.
* @param pvUser User argument.
*/
/** Pointer to a RTUDPSERVE(). */
typedef FNRTUDPSERVE *PFNRTUDPSERVE;
/**
* Create single datagram at a time UDP Server in a separate thread.
*
* The thread will loop accepting datagrams and call pfnServe for
* each of the incoming datagrams in turn. The pfnServe function can
* return VERR_UDP_SERVER_STOP too terminate this loop. RTUdpServerDestroy()
* should be used to terminate the server.
*
* @returns iprt status code.
* @param pszAddress The address for creating a datagram socket.
* If NULL or empty string the server is bound to all interfaces.
* @param uPort The port for creating a datagram socket.
* @param enmType The thread type.
* @param pszThrdName The name of the worker thread.
* @param pfnServe The function which will handle incoming datagrams.
* @param pvUser User argument passed to pfnServe.
* @param ppServer Where to store the serverhandle.
*/
RTR3DECL(int) RTUdpServerCreate(const char *pszAddress, unsigned uPort, RTTHREADTYPE enmType, const char *pszThrdName,
/**
* Create single datagram at a time UDP Server.
* The caller must call RTUdpServerReceive() to actually start the server.
*
* @returns iprt status code.
* @param pszAddress The address for creating a datagram socket.
* If NULL the server is bound to all interfaces.
* @param uPort The port for creating a datagram socket.
* @param ppServer Where to store the serverhandle.
*/
/**
* Shuts down the server.
*
* @returns IPRT status code.
* @param pServer Handle to the server.
*/
/**
* Closes down and frees a UDP Server.
*
* @returns iprt status code.
* @param pServer Handle to the server.
*/
/**
* Listen for incoming datagrams.
*
* The function will loop waiting for datagrams and call pfnServe for
* each of the incoming datagrams in turn. The pfnServe function can
* return VERR_UDP_SERVER_STOP too terminate this loop. A stopped server
* can only be destroyed.
*
* @returns iprt status code.
* @param pServer The server handle as returned from RTUdpServerCreateEx().
* @param pfnServe The function which will handle incoming datagrams.
* @param pvUser User argument passed to pfnServe.
*/
/**
* Receive data from a socket.
*
* @returns iprt status code.
* @param Sock Socket descriptor.
* @param pvBuffer Where to put the data we read.
* @param cbBuffer Read buffer size.
* @param pcbRead Number of bytes read. Must be non-NULL.
*/
RTR3DECL(int) RTUdpRead(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead, PRTNETADDR pSrcAddr);
/**
* Send data to a socket.
*
* @returns iprt status code.
* @retval VERR_INTERRUPTED if interrupted before anything was written.
*
* @param pServer Handle to the server.
* @param pvBuffer Buffer to write data to socket.
* @param cbBuffer How much to write.
* @param pDstAddr Destination address.
*/
/** @} */
#endif