fc-magnetite: src/g23m-fad/tcpip/rnet/rnet

annotate src/g23m-fad/tcpip/rnet/rnet_api.h @ 640:16eb1b9640dc

target gtm900 renamed to gtm900mgc2 This change reflects the fact that the build target in question supports MGC2GSMT hardware only, and will NOT work on other hw that confusing bears the same end user name of GTM900, neither the LoCosto-based GTM900-C nor the Calypso-based MG01GSMT that has a different and incompatible RFFE. If we ever get our hands on a piece of MG01GSMT hw and add support for it, that other target will be named gtm900mg01.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Fri, 31 Jan 2020 00:46:07 +0000
parents	90eb61ecd093
children

rev	line source
174 90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 * @file rnet_api.h
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 * Riviera NET.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 * Declarations of the Riviera TCP/IP stack asynchronous
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7 * (non-blocking) API.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 * See the Readme.txt file.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 * @author Vincent Oberle (v-oberle@ti.com)
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 * @version 0.1
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14 /*
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 * History:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 * Date Author Modification
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 * --------------------------------------------------
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 * 01/25/2002 Vincent Oberle Create
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20 * 03/14/2002 Vincent Oberle Added rnet_shutdown
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25 #ifndef __RNET_API_H_
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 #define __RNET_API_H_
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 /*
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29 * IMPORTANT NOTE FOR WINDOWS 2000 USERS
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 * It has been observed that the Winsocket version of the RNET implementation
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32 * does not function correctly under Windows 2000. Connection to a host on the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 * Internet does not work.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34 * This problem does not appear under NT4 and XP.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 #include "rv_general.h"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38 #include "rvf_api.h"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40 #include "rnet_cfg.h"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41 #include "rnet_ip_addr.h"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 #ifdef __cplusplus
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 extern "C"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45 {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 #endif
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 /***********************
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 * Types and constants *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 ***********************/
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53 * Protocols supported.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 * Even if the interface has some similarities to the socket API,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 * only the Internet protocols TCP and UDP are supported.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58 * RNET_IPPROTO_UNDEFINED can never be passed to a function,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59 * but only returned by rnet_get_proto when the stack gets corrupted
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 * or any other problem.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 typedef enum {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 RNET_IPPROTO_UNDEFINED = 0,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 RNET_IPPROTO_TCP = 6,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 RNET_IPPROTO_UDP = 17
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 /* RNET_IPPROTO_ICMP = 1 not supported (yet?) */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 } T_RNET_IPPROTO;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70 * Traffic class.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72 * @todo Values to be defined.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 typedef enum {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 RNET_TRAFFIC_CLASS_DEFAULT,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76 RNET_TRAFFIC_CLASS_WAP,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 RNET_TRAFFIC_CLASS_FTP,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 /* or */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79 RNET_TRAFFIC_CLASS_LOWDELAY,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 RNET_TRAFFIC_CLASS_BACKGROUND,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 RNET_TRAFFIC_CLASS_BEST_EFFORT,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82 RNET_TRAFFIC_CLASS_NETWORK
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83 } T_RNET_TRAFFIC_CLASS;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 * Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 * This structure is equivalent to the socket descriptor.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 * The content of this structure is specific to the TCP/IP implementation
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90 * and not seen by the user of RNET.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91 * In no case should the application developer manipulate directly the content
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 * of the structure. He/she only sees a pointer on it.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 #ifdef _WINDOWS
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 #if defined RNET_CFG_WINSOCK
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 typedef struct T_RNET_WS_DESC T_RNET_DESC;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 #elif defined RNET_CFG_REAL_TRANSPORT
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 typedef struct T_RNET_RT_SOCK T_RNET_DESC;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 #endif
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 #else
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101 #if defined RNET_CFG_BRIDGE
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102 typedef struct T_RNET_BR_DESC T_RNET_DESC;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103 #elif defined RNET_CFG_REAL_TRANSPORT
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104 typedef struct T_RNET_RT_SOCK T_RNET_DESC;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 #endif
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 #endif
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109 * Net package return values and error codes. They are both used for
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110 * API function return values and in the RNET_ERROR_IND error message.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 * Please note that some are specific to RNET and are not found
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 * among the standard Riviera return code.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 typedef enum {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116 /*
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 * Standard RV return values
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 ****************************/
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120 RNET_OK = RV_OK,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 RNET_MEMORY_ERR = RV_MEMORY_ERR,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 RNET_INVALID_PARAMETER = RV_INVALID_PARAMETER,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 * The protocol type or the specified protocol is not
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 * supported by the system.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 * The specified feature is not implemented.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 RNET_NOT_SUPPORTED = RV_NOT_SUPPORTED,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 RNET_NOT_READY = RV_NOT_READY,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135 RNET_INTERNAL_ERR = RV_INTERNAL_ERR,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137 /*
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 * RNET specific return values
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 ******************************/
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 * Another connection is bound to the same port,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143 * address or socket.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 RNET_IN_USE = -50,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 * The protocol stack wasn't initialised.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149 * See rnet_ws_startup().
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151 RNET_NOT_INITIALIZED = -51,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 * The network cannot be reached from this host at this time.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 RNET_NET_UNREACHABLE = -52,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159 * Attempt to connect timed out without establishing a connection.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 RNET_TIMEOUT = -53,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 * The attempt to connect was forcefully rejected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166 RNET_CONN_REFUSED = -54,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169 * The connection was reset by the remote side.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171 RNET_CONN_RESET = -55,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174 * The connection was terminated due to a time-out or other failure.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176 RNET_CONN_ABORTED = -56,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179 * The connection was gracefully closed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 RNET_CONN_CLOSED = -57,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184 * The connection is message oriented (UDP), and the message is larger than the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 * maximum supported by the underlying transport.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 RNET_MSG_SIZE = -58,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190 * Not all bytes have been sent in a send operations.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 RNET_PARTIAL_SENT = -59,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 * For host search.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 * Indicates that a host was not found.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198 RNET_HOST_NOT_FOUND = -60
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200 } T_RNET_RET;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202 /*************
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 * Functions *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204 *************/
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	206 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	207 * Creates a new connection identifier (T_RNET_DESC).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	208 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	209 * The connection ID is not active until it has either been bound
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	210 * to a local address or connected to a remote address.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	211 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	212 * @param proto Protocol that should be used [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	213 * @param desc Connection identifier created [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	214 * @param return_path Return path that should be used to send
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	215 * the messages like accept, connect, etc [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	216 * @return RNET_MEMORY_ERR No available memory to create the new connection id.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	217 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	218 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	219 * or No more socket descriptors available.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	220 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	221 * RNET_NOT_SUPPORTED Specified protocol not supported.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	222 * RNET_OK Connection ID successfully created.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	223 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	224 T_RNET_RET rnet_new (T_RNET_IPPROTO proto,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	225 T_RNET_DESC ** desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	226 T_RV_RETURN_PATH return_path);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	227
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	228 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	229 * Sets the traffic class of a connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	230 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	231 * Note that this function is NOT implemented under Windows.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	232 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	233 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	234 * @param traffic_class Traffic class, see T_RNET_TRAFFIC_CLASS
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	235 * for more details.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	236 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	237 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	238 * RNET_INVALID_PARAMETER Invalid connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	239 * or Specified traffic class not valid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	240 * RNET_OK Traffic class successfully set.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	241 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	242 T_RNET_RET rnet_set_traffic_class (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	243 T_RNET_TRAFFIC_CLASS traffic_class);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	244
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	245 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	246 * Binds the connection to a local IP address and port number.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	247 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	248 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	249 * @param local_addr Local IP address
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	250 * The IP address can be specified as RNET_IP_ADDR_ANY
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	251 * in order to bind the connection to all local IP addresses [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	252 * @param local_port If the port is not specified, the allocation of a port
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	253 * is done automatically by the system [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	254 * @return RNET_IN_USE Another connection bound to the same address/port.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	255 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	256 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	257 * RNET_INVALID_PARAMETER Invalid connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	258 * or Specified address not a valid address
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	259 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	260 * RNET_MEMORY_ERR Not enough buffers available, too many connections.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	261 * RNET_OK Connection successfully bound.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	262 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	263 T_RNET_RET rnet_bind (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	264 T_RNET_IP_ADDR local_addr,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	265 T_RNET_PORT local_port);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	266
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	267 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	268 * Commands a connection to start listening for incoming connections.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	269 * When an incoming connection is accepted, an RNET_CONNECT_IND message is sent.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	270 * The connection ID will have to be bound to a local port
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	271 * with the rnet_bind() function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	272 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	273 * Note that there is no accept function: After a call to listen,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	274 * the application can receive RNET_ACCEPTED messages.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	275 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	276 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	277 * @return RNET_MEMORY_ERR No available memory for the listening connection.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	278 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	279 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	280 * or No more socket descriptors available.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	281 * RNET_INVALID_PARAMETER Invalid connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	282 * or Connection not bound with bind.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	283 * or The ID does not support listening operation.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	284 * RNET_IN_USE Connection already connected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	285 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	286 * RNET_OK Listening successfully started.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	287 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	288 T_RNET_RET rnet_listen (T_RNET_DESC *desc);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	289
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	290 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	291 * Sets up the connection ID to connect to the remote host and sends the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	292 * initial SYN segment which opens the connection.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	293 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	294 * For the connection-oriented client (TCP), it prepares a connection from the local
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	295 * to the peer system. The connection oriented client does not need
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	296 * to call rnet_bind() before rnet_connect(), since rnet_connect() would automatically
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	297 * use the local address of the client and allocate dynamically a free local port.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	298 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	299 * rnet_connect() returns immediately, does not wait for the connection to be properly setup.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	300 * The RNET_CONNECT_CFM message is sent when the connection is established.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	301 * If the connection could not be properly established, a RNET_ERROR_IND
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	302 * message is sent.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	303 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	304 * A connectionless client (UDP) would use rnet_connect() to locally specify
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	305 * the remote server, but no connection is open. But the remote address
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	306 * is then known and does not need to be specified again.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	307 * rnet_connect() takes as parameter a fully initialized address structure,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	308 * specifying server address and port.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	309 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	310 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	311 * @param peer_addr Peer address [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	312 * @param peer_port Peer port [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	313 * @return RNET_MEMORY_ERR No buffer space available.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	314 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	315 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	316 * or Attempt to connect forcefully rejected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	317 * or Attempt to connect datagram socket to broadcast address
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	318 * RNET_INVALID_PARAMETER Invalid connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	319 * or Remote address not a valid address (such as ADDR_ANY).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	320 * RNET_NOT_SUPPORTED Addresses in the specified family cannot be used with this socket.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	321 * RNET_IN_USE Already connected (connection-oriented only).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	322 * RNET_NET_UNREACHABLE The network cannot be reached from this host at this time.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	323 * RNET_TIMEOUT Attempt to connect timed out without establishing a connection.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	324 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	325 * RNET_OK Connection in progress
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	326 * RNET_CONNECT_CFM will be sent when the connection
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	327 * has been successfully completed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	328 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	329 T_RNET_RET rnet_connect (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	330 T_RNET_IP_ADDR peer_addr,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	331 T_RNET_PORT peer_port);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	332
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	333 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	334 * Enqueues the data for sending.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	335 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	336 * Data is sent by enqueueing the data with a call to rnet_send().
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	337 * The function is not-blocking.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	338 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	339 * Returns RNET_PARTIAL_SENT if not all data could be sent and the function
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	340 * needs to be called again later to send the rest of the data. In that case,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	341 * the out value of len_p is the number of bytes effectively sent.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	342 * The remaining data can be sent when the message RNET_SEND_RDY is received.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	343 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	344 * If no RNET_PARTIAL_SENT is returned, but RNET_OK, more data can be
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	345 * immediately sent. No RNET_SEND_RDY is sent to the SWE.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	346 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	347 * The buffer is copied by RNET, so the application can free the data buffer
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	348 * when the function returns.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	349 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	350 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	351 * @param buff Pointer on the data to send [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	352 * @param len_p Pointer on the length of the data to send [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	353 * Pointer on the length of the data effectively sent [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	354 * @return RNET_MEMORY_ERR Not enough memory is available
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	355 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	356 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	357 * or Requested address is a broadcast address.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	358 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	359 * or The ID is not connected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	360 * or Invalid buff parameter.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	361 * or Connection not bound with bind.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	362 * RNET_CONN_ABORTED Connection broken due to the "keep-alive" activity
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	363 * detecting a failure while the operation was in progress.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	364 * or Virtual circuit terminated due to a time-out or other failure.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	365 * RNET_MSG_SIZE Message oriented connection (UDP), and the message
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	366 * is larger than the maximum supported by the underlying transport.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	367 * RNET_NET_UNREACHABLE Remote host cannot be reached from this host at this time.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	368 * RNET_CONN_RESET The virtual circuit was reset by the remote side executing a "hard"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	369 * or "abortive" close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	370 * RNET_TIMEOUT The connection has been dropped, because of a
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	371 * network failure or because the system on the other end went down
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	372 * without notice.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	373 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	374 * RNET_OK Sending in progress.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	375 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	376 T_RNET_RET rnet_send (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	377 T_RVF_BUFFER * buff,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	378 UINT16 * len_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	379
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	380 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	381 * Read the waiting data (not-blocking).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	382 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	383 * Data reception is message based: When the application receives a
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	384 * T_RNET_RECV_IND message, it can read the data with this
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	385 * rnet_recv() function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	386 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	387 * The data are copied in the buffer given by the application to RNET
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	388 * via this rnet_recv function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	389 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	390 * Datagram oriented (UDP)
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	391 * -----------------------
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	392 * When an UDP datagram arrives, the receiver application receives
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	393 * a T_RNET_RECV_IND message. The application can then read the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	394 * datagram with the rnet_recv function. The buffer passed to the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	395 * function should be big enough to contain a UDP datagram, otherwise
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	396 * the message is not put in the buffer and the error code
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	397 * RNET_MSG_SIZE is returned.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	398 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	399 * The OUT value of the len_p parameter can have two possible values:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	400 * - If there was data to read and no error detected (function
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	401 * returned RNET_OK), len_p contains the size of the received datagram.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	402 * - If there was no error, but no data to read, len_p contains 0.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	403 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	404 * RNET will only send a new T_RNET_RECV_IND with a specific descriptor
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	405 * when a rnet_recv function has been called that returned a len_p parameter
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	406 * with a 0 value. Therefore, the application should loop on rnet_recv when
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	407 * it receives a T_RNET_RECV_IND message, like:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	408 * UINT16 *len_p = -1;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	409 * while (*len_p != 0) {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	410 * ret = rnet_recv(desc, buff, len_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	411 * ...
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	412 * }
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	413 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	414 * Stream oriented (TCP)
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	415 * ---------------------
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	416 * When a new stream of data arrives on a connection, the receiver
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	417 * application receives a T_RNET_RECV_IND. It can then read the flow
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	418 * with the rnet_recv function, until the len_p parameter is returned
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	419 * with a 0 value.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	420 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	421 * The stack will only send a new T_RNET_RECV_IND message when
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	422 * rnet_recv has been called and has returned the len_p parameter with a 0.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	423 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	424 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	425 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	426 * @param buff Buffer to store the received data [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	427 * @param len_p Pointer on the length of the passed buffer [IN]
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	428 * Pointer on the size of the received data in the buffer [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	429 * @return RNET_MEMORY_ERR Not enough memory is available
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	430 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	431 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	432 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	433 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	434 * or The ID is not connected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	435 * or Invalid buff parameter.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	436 * or Connection not bound with bind.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	437 * RNET_CONN_ABORTED Connection broken due to the "keep-alive" activity
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	438 * detecting a failure while the operation was in progress.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	439 * or Virtual circuit terminated due to a time-out or other failure.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	440 * RNET_MSG_SIZE The socket is message oriented (UDP), and the message
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	441 * was too large to fit into the specified buffer and was truncated.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	442 * RNET_CONN_RESET The virtual circuit was reset by the remote side executing a "hard"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	443 * or "abortive" close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	444 * RNET_TIMEOUT The connection has been dropped, because of a
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	445 * network failure or because the system on the other end went down
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	446 * without notice.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	447 * RNET_NET_UNREACHABLE Remote host cannot be reached from this host at this time.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	448 * RNET_OK Data successfully read.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	449 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	450 T_RNET_RET rnet_recv (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	451 T_RVF_BUFFER *buff,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	452 UINT16 * len_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	453
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	454 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	455 * Read the waiting data (not-blocking). Similar to rnet_recv,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	456 * BUT FOR UDP ONLY.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	457 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	458 * See rnet_recv.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	459 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	460 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	461 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	462 * @param buff Buffer to store the received data [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	463 * @param len_p Pointer on the length of the passed buffer [IN]
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	464 * Pointer on the size of the received data in the buffer [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	465 * @return RNET_MEMORY_ERR Not enough memory is available
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	466 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	467 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	468 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	469 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	470 * or The ID is connected.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	471 * or Invalid buff parameter.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	472 * or Connection not bound with bind.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	473 * RNET_CONN_ABORTED Connection broken due to the "keep-alive" activity
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	474 * detecting a failure while the operation was in progress.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	475 * or Virtual circuit terminated due to a time-out or other failure.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	476 * RNET_MSG_SIZE The socket is message oriented (UDP), and the message
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	477 * was too large to fit into the specified buffer and was truncated.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	478 * RNET_CONN_RESET The virtual circuit was reset by the remote side executing a "hard"
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	479 * or "abortive" close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	480 * RNET_TIMEOUT The connection has been dropped, because of a
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	481 * network failure or because the system on the other end went down
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	482 * without notice.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	483 * RNET_NET_UNREACHABLE Remote host cannot be reached from this host at this time.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	484 * RNET_OK Data successfully read.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	485 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	486 T_RNET_RET rnet_recv_from (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	487 T_RVF_BUFFER * buff,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	488 UINT16 * len_p,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	489 T_RNET_IP_ADDR * from_addr,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	490 T_RNET_PORT * from_port);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	491
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	492 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	493 * Disables the sending on a socket and informs the peer
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	494 * about it.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	495 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	496 * Subsequent calls to the send function are disallowed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	497 * For TCP sockets, a FIN will be sent after all data is sent and acknowledged by the receiver.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	498 * The rnet_shutdown function does not frees the connection ID. Any resources attached
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	499 * to the ID will not be freed until rnet_close is invoked.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	500 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	501 * To assure that all data is sent and received on a connection (TCP) before it
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	502 * is closed, an application should use rnet_shutdown to close connection before calling
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	503 * rnet_close. For example, to initiate a graceful disconnect:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	504 * 1) Call rnet_shutdown.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	505 * 2) When RNET_ERROR_IND with RNET_CONN_CLOSED is received, call rnet_recv until
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	506 * the len parameter is zero.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	507 * 3) Call rnet_close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	508 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	509 * Following technique describes how to minimize the chance of problems
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	510 * occurring during connection teardown. In this example, the client is responsible for
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	511 * initiating a graceful shutdown.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	512 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	513 * Client Side Server Side
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	514 * (1) Invoke rnet_shutdown to
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	515 * signal end of session and that
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	516 * client has no more data to send.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	517 * (2) Receive RNET_ERROR_IND with RNET_CONN_CLOSED,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	518 * indicating graceful shutdown in progress
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	519 * and that all data has been received.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	520 * (3) Send any remaining response data with rnet_send.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	521 * (5') Get RNET_RECV_IND and (4) Invoke rnet_shutdown to
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	522 * invoke rnet_recv to get any indicate server has no more data to send.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	523 * response data sent by server.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	524 * (5) Receive RNET_ERROR_IND (4') Invoke rnet_close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	525 * with RNET_CONN_CLOSED.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	526 * (6) Invoke rnet_close.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	527 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	528 * The timing sequence is maintained from step (1) to step (6) between the client and
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	529 * the server, except for step (4') and (5') which only has local timing significance in
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	530 * the sense that step (5) follows step (5') on the client side while step (4') follows
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	531 * step (4) on the server side, with no timing relationship with the remote party.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	532 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	533 * @param desc Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	534 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	535 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	536 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	537 * The descriptor is not connected (TCP only).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	538 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	539 * RNET_OK Connection shutdown, sending impossible
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	540 * RNET_ERROR_IND with the parameter RNET_CONN_CLOSED
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	541 * will be sent to the peer.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	542 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	543 T_RNET_RET rnet_shutdown (T_RNET_DESC * desc);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	544
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	545 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	546 * Closes the connection.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	547 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	548 * Use it to release the connection ID so further references to it will fail with
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	549 * the error RNET_INVALID_PARAMETER.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	550 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	551 * An application should always have a matching call to rnet_close for each successful
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	552 * call to rnet_new to return any resources to the system.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	553 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	554 * The function may return RNET_MEMORY_ERR if no memory
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	555 * was available for closing the connection. If so, the application
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	556 * should wait and try again either by using the error message
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	557 * or the polling functionality.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	558 * If the close succeeds, the function returns RNET_OK.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	559 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	560 * The connection ID is deallocated by a call to rnet_close().
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	561 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	562 * IMPORTANT: If an application wants to call rnet_close after having received
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	563 * a close event (RNET_ERROR_IND message with error parameter set to RNET_CONN_CLOSED),
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	564 * it should check that there are no remaining data to be read (data arrived after
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	565 * the RNET_ERROR_IND message, so that no RNET_RECV_IND was received yet).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	566 * A way to do it is:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	567 * T_RVF_BUFFER * buff;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	568 * UINT16 len;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	569 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	570 * RNET_TRACE_LOW("Read remaining data");
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	571 * len = 100;
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	572 * while (len > 0) {
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	573 * rvf_get_buf(rtest_get_mb_id(), len, (T_RVF_BUFFER**)&buff);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	574 * rnet_recv(error_ind_msg_p->desc, buff, (UINT16*)&len);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	575 * rvf_send_trace(buff, len, NULL_PARAM, RV_TRACE_LEVEL_DEBUG_LOW, RTEST_USE_ID);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	576 * rvf_free_buf(buff);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	577 * }
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	578 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	579 * @param desc Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	580 * @return RNET_MEMORY_ERR Not enough memory is available
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	581 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	582 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	583 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	584 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	585 * RNET_OK Socket closed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	586 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	587 T_RNET_RET rnet_close (T_RNET_DESC * desc);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	588
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	589 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	590 * Gets the local address and port of a connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	591 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	592 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	593 * @param local_addr_p Local IP address [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	594 * @param local_port_p Local port [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	595 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	596 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	597 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	598 * or Not bound to an address with bind.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	599 * or ADDR_ANY is specified in bind but connection not yet occurred.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	600 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	601 * RNET_OK Local address/port successfully get.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	602 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	603 T_RNET_RET rnet_get_local_addr_port (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	604 T_RNET_IP_ADDR * local_addr_p,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	605 T_RNET_PORT * local_port_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	606
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	607 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	608 * Use to determine the amount of data pending in the network's input buffer
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	609 * that can be read from the connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	610 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	611 * If desc is stream oriented (TCP), returns the amount of data that can be read
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	612 * in a single call to the rnet_recv function; this might not be the same as the
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	613 * total amount of data queued on the socket.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	614 * If desc is message oriented (UDP), returns the size of the first datagram
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	615 * (message) queued on the socket.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	616 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	617 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	618 * @param size_p Pointer to an unsigned int in which the result is stored [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	619 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	620 * RNET_INTERNAL_ERR Network subsystem failed.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	621 * RNET_INVALID_PARAMETER The connection ID is invalid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	622 * RNET_NOT_READY Still processing a callback function.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	623 * RNET_OK Value successfully get.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	624 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	625 T_RNET_RET rnet_get_buff_size (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	626 UINT32 * size_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	627
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	628 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	629 * Indicates the maximum send size of a message for message-oriented
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	630 * descriptor (UDP) as implemented by a particular service provider.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	631 * It has no meaning for TCP.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	632 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	633 * @param desc Connection identifier [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	634 * @param size_p Pointer to an unsigned int in which the result is stored [OUT].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	635 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	636 T_RNET_RET rnet_get_max_packet_size (T_RNET_DESC * desc,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	637 UINT32 * size_p);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	638
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	639 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	640 * Requests host information corresponding to a host name or to a
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	641 * network address.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	642 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	643 * One of the two parameters name or addr must be NULL.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	644 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	645 * This function is bridge function sending a corresponding message to RNET.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	646 * The message RNET_HOST_INFO is sent back when the requested information
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	647 * is available or if the request failed:
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	648 * If RNET_HOST_INFO "error" parameter is RNET_OK, no error occured and
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	649 * the host_name, host_addr and user_data parameters are valid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	650 * If RNET_HOST_INFO "error" parameter is different from RNET_OK, the host
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	651 * information could not be retrieved and only user_data is valid.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	652 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	653 * Note that this function does not need a connection identifier and specifies
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	654 * its own return path.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	655 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	656 * @param name Name of the host to resolve [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	657 * @param addr Network address [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	658 * @param return_path Return path for sending the response [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	659 * @param user_data Pointer on some user-defined data that
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	660 * will be contained in the RNET_HOST_INFO message [IN].
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	661 * @return RNET_MEMORY_ERR Not enough memory is available.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	662 * RNET_OK The message could be correctly send.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	663 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	664 T_RNET_RET rnet_get_host_info (char *name,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	665 T_RNET_IP_ADDR addr,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	666 T_RV_RETURN_PATH return_path,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	667 void * user_data);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	668
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	669 /*
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	670 * Following functions are not directly part of the networking API,
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	671 * but they are used to retrieve some simple information from a connection
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	672 * descriptor. They are simple blocking functions, not sending any messages.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	673 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	674
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	675 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	676 * Retrieves the protocol associated to a connection descriptor.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	677 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	678 * @param desc Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	679 * @return A value of the T_RNET_IPPROTO enumeration.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	680 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	681 T_RNET_IPPROTO rnet_get_proto (T_RNET_DESC *desc);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	682
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	683 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	684 * Associates an application specific pointer to a connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	685 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	686 * @param desc Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	687 * @param user_data Pointer that can be used by an application to store
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	688 * application specific data.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	689 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	690 void rnet_set_user_data (T_RNET_DESC desc, void user_data);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	691
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	692 /**
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	693 * Returns the application specific pointer associated to the connection ID.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	694 *
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	695 * @param desc Connection identifier.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	696 * @return Application specific data.
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	697 */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	698 void * rnet_get_user_data (T_RNET_DESC *desc);
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	699
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	700 #ifdef __cplusplus
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	701 }
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	702 #endif
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	703
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	704 #endif /* __RNET_API_H_ */
90eb61ecd093 src/g23m-fad: initial import from TCS3.2/LoCosto Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	705

FreeCalypso > hg > fc-magnetite

annotate src/g23m-fad/tcpip/rnet/rnet_api.h @ 640:16eb1b9640dc