fc-selenite: src/g23m-fad/tcpip/rnet/rnet_rt/rnet_rt

annotate src/g23m-fad/tcpip/rnet/rnet_rt/rnet_rt_api.h @ 204:027b22814ac4

targets/fcdev3b.h: sync with Magnetite

author	Mychaela Falconia <falcon@freecalypso.org>
date	Tue, 13 Oct 2020 01:04:20 +0000
parents	d393cd9bb723
children

rev	line source
1 d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	1 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	2 * @file rnet_rt_api.h
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	3 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	4 * API Definition for RNET_RT SWE.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	5 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	6 * @author Jose Yp-Tcha (j-yp-tcha@ti.com)
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	7 * @version 0.1
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	8 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	9
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	10 /*
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	11 * $Id: rnet_rt_api.h,v 1.5 2002/10/30 15:23:34 rf Exp $
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	12 * $Name: ti_20021030 $
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	13 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	14 * History:
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	15 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	16 * Date Author Modification
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	17 * -------------------------------------------------------------------
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	18 * 3/19/2002 Jose Yp-Tcha (j-yp-tcha@ti.com) Create.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	19 * 4/3/2002 Regis Feneon ngip api
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	20 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	21 * (C) Copyright 2002 by TI, All Rights Reserved
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	22 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	23
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	24 #include "rnet_cfg.h"
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	25
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	26 #ifdef RNET_CFG_REAL_TRANSPORT
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	27
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	28 #ifndef __RNET_RT_API_H_
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	29 #define __RNET_RT_API_H_
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	30
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	31 #include "rvm_gen.h" /* Generic RVM types and functions. */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	32 #include "rnet_api.h"
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	33
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	34 #ifdef __cplusplus
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	35 extern "C"
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	36 {
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	37 #endif
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	38
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	39 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	40 * @name RNET_RT Return type and return values.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	41 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	42 * Currently they are the standard RV return types, but they may
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	43 * be customized in the future.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	44 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	45 /@{/
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	46
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	47 #define RNET_RT_OK RV_OK
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	48 #define RNET_RT_NOT_SUPPORTED RV_NOT_SUPPORTED
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	49 #define RNET_RT_MEMORY_ERR RV_MEMORY_ERR
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	50 #define RNET_RT_INTERNAL_ERR RV_INTERNAL_ERR
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	51 /@}/
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	52
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	53 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	54 * @name API functions
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	55 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	56 * API functions declarations (bridge functions).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	57 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	58 /@{/
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	59
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	60 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	61 * Creates a new connection identifier (T_RNET_DESC).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	62 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	63 * The connection ID is not active until it has either been bound
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	64 * to a local address or connected to a remote address.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	65 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	66 * @param proto Protocol that should be used [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	67 * @param desc Connection identifier created [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	68 * @param return_path Return path that should be used to send
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	69 * the messages like accept, connect, etc [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	70 * @return RNET_MEMORY_ERR No available memory to create the new connection id.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	71 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	72 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	73 * or No more socket descriptors available.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	74 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	75 * RNET_NOT_SUPPORTED Specified protocol not supported.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	76 * RNET_OK Connection ID successfully created.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	77 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	78 T_RNET_RET rnet_rt_new ( T_RNET_IPPROTO proto,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	79 T_RNET_DESC ** desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	80 T_RV_RETURN_PATH return_path);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	81
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	82 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	83 * Binds the connection to a local IP address and port number.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	84 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	85 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	86 * @param local_addr Local IP address
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	87 * The IP address can be specified as RNET_IP_ADDR_ANY
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	88 * in order to bind the connection to all local IP addresses [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	89 * @param local_port If the port is not specified, the allocation of a port
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	90 * is done automatically by the system [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	91 * @return RNET_IN_USE Another connection bound to the same address/port.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	92 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	93 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	94 * RNET_INVALID_PARAMETER Invalid connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	95 * or Specified address not a valid address
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	96 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	97 * RNET_MEMORY_ERR Not enough buffers available, too many connections.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	98 * RNET_OK Connection successfully bound.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	99 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	100 T_RNET_RET rnet_rt_bind (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	101 T_RNET_IP_ADDR local_addr,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	102 T_RNET_PORT local_port);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	103
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	104 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	105 * Commands a connection to start listening for incoming connections.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	106 * When an incoming connection is accepted, an RNET_ACCEPTED message is sent.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	107 * The connection ID will have to be bound to a local port
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	108 * with the rnet_bind() function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	109 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	110 * Note that there is no accept function: After a call to listen,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	111 * the application can receive RNET_ACCEPTED messages.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	112 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	113 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	114 * @return RNET_MEMORY_ERR No available memory for the listening connection.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	115 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	116 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	117 * or No more socket descriptors available.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	118 * RNET_INVALID_PARAMETER Invalid connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	119 * or Connection not bound with bind.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	120 * or The ID does not support listening operation.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	121 * RNET_IN_USE Connection already connected.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	122 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	123 * RNET_OK Listening successfully started.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	124 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	125 T_RNET_RET rnet_rt_listen (T_RNET_DESC *desc);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	126
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	127 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	128 * Sets up the connection ID to connect to the remote host and sends the
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	129 * initial SYN segment which opens the connection.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	130 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	131 * For the connection-oriented client (TCP), it prepares a connection from the local
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	132 * to the peer system. The connection oriented client does not need
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	133 * to call rnet_bind() before rnet_connect(), since rnet_connect() would automatically
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	134 * use the local address of the client and allocate dynamically a free local port.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	135 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	136 * rnet_connect() returns immediately, does not wait for the connection to be properly setup.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	137 * The RNET_CONNECT_CFM message is sent when the connection is established.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	138 * If the connection could not be properly established, a RNET_ERROR_IND
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	139 * message is sent.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	140 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	141 * A connectionless client (UDP) would use rnet_connect() to locally specify
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	142 * the remote server, but no connection is open. But the remote address
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	143 * is then known and does not need to be specified again.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	144 * rnet_connect() takes as parameter a fully initialized address structure,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	145 * specifying server address and port.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	146 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	147 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	148 * @param peer_addr Peer address [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	149 * @param peer_port Peer port [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	150 * @return RNET_MEMORY_ERR No buffer space available.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	151 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	152 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	153 * or Attempt to connect forcefully rejected.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	154 * or Attempt to connect datagram socket to broadcast address
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	155 * RNET_INVALID_PARAMETER Invalid connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	156 * or Remote address not a valid address (such as ADDR_ANY).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	157 * RNET_NOT_SUPPORTED Addresses in the specified family cannot be used with this socket.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	158 * RNET_IN_USE Already connected (connection-oriented only).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	159 * RNET_NET_UNREACHABLE The network cannot be reached from this host at this time.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	160 * RNET_TIMEOUT Attempt to connect timed out without establishing a connection.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	161 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	162 * RNET_OK Connection in progress
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	163 * RNET_CONNECT_CFM will be sent when the connection
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	164 * has been successfully completed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	165 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	166 T_RNET_RET rnet_rt_connect (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	167 T_RNET_IP_ADDR peer_addr,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	168 T_RNET_PORT peer_port);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	169
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	170 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	171 * Enqueues the data for sending.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	172 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	173 * Data is sent by enqueueing the data with a call to rnet_send().
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	174 * The function is not-blocking.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	175 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	176 * Returns RNET_PARTIAL_SENT if not all data could be sent and the function
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	177 * needs to be called again later to send the rest of the data. In that case,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	178 * the out value of len_p is the number of bytes effectively sent.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	179 * The remaining data can be sent when the message RNET_SEND_RDY is received.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	180 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	181 * The buffer is copied by RNET, so the application can free the data buffer
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	182 * when the function returns.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	183 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	184 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	185 * @param buff Pointer on the data to send [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	186 * @param len_p Pointer on the length of the data to send [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	187 * Pointer on the length of the data effectively sent [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	188 * @return RNET_MEMORY_ERR Not enough memory is available
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	189 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	190 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	191 * or Requested address is a broadcast address.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	192 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	193 * or The ID is not connected.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	194 * or Invalid buff parameter.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	195 * or Connection not bound with bind.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	196 * RNET_CONN_ABORTED Connection broken due to the "keep-alive" activity
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	197 * detecting a failure while the operation was in progress.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	198 * or Virtual circuit terminated due to a time-out or other failure.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	199 * RNET_MSG_SIZE Message oriented connection (UDP), and the message
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	200 * is larger than the maximum supported by the underlying transport.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	201 * RNET_NET_UNREACHABLE Remote host cannot be reached from this host at this time.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	202 * RNET_CONN_RESET The virtual circuit was reset by the remote side executing a "hard"
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	203 * or "abortive" close.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	204 * RNET_TIMEOUT The connection has been dropped, because of a
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	205 * network failure or because the system on the other end went down
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	206 * without notice.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	207 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	208 * RNET_OK Sending in progress
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	209 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	210 T_RNET_RET rnet_rt_send (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	211 T_RVF_BUFFER * buff,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	212 UINT16 * len_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	213
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	214 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	215 * Read the waiting data (not-blocking).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	216 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	217 * Data reception is message based: When the application receives a
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	218 * T_RNET_RECV_IND message, it can read the data with this
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	219 * rnet_recv() function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	220 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	221 * The data are copied in the buffer given by the application to RNET
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	222 * via this rnet_recv function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	223 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	224 * Datagram oriented (UDP)
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	225 * -----------------------
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	226 * When an UDP datagram arrives, the receiver application receives
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	227 * a T_RNET_RECV_IND message. The application can then read the
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	228 * datagram with the rnet_recv function. The buffer passed to the
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	229 * function should be big enough to contain a UDP datagram, otherwise
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	230 * the message is not put in the buffer and the error code
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	231 * RNET_MSG_SIZE is returned.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	232 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	233 * The OUT value of the len_p parameter can have two possible values:
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	234 * - If there was data to read and no error detected (function
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	235 * returned RNET_OK), len_p contains the size of the received datagram.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	236 * - If there was no error, but no data to read, len_p contains 0.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	237 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	238 * RNET will only send a new T_RNET_RECV_IND with a specific descriptor
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	239 * when a rnet_recv function has been called that returned a len_p parameter
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	240 * with a 0 value. Therefore, the application should loop on rnet_recv when
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	241 * it receives a T_RNET_RECV_IND message, like:
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	242 * UINT16 *len_p = -1;
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	243 * while (*len_p != 0) {
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	244 * ret = rnet_recv(desc, buff, len_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	245 * ...
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	246 * }
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	247 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	248 * Stream oriented (TCP)
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	249 * ---------------------
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	250 * When a new stream of data arrives on a connection, the receiver
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	251 * application receives a T_RNET_RECV_IND. It can then read the flow
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	252 * with the rnet_recv function, until the len_p parameter is returned
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	253 * with a 0 value.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	254 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	255 * The stack will only send a new T_RNET_RECV_IND message when
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	256 * rnet_recv has been called and has returned the len_p parameter with a 0.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	257 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	258 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	259 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	260 * @param buff Buffer to store the received data [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	261 * @param len_p Pointer on the length of the passed buffer [IN]
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	262 * Pointer on the size of the received data in the buffer [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	263 * @return RNET_MEMORY_ERR Not enough memory is available
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	264 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	265 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	266 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	267 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	268 * or The ID is not connected.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	269 * or Invalid buff parameter.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	270 * or Connection not bound with bind.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	271 * RNET_CONN_ABORTED Connection broken due to the "keep-alive" activity
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	272 * detecting a failure while the operation was in progress.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	273 * or Virtual circuit terminated due to a time-out or other failure.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	274 * RNET_MSG_SIZE The socket is message oriented (UDP), and the message
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	275 * was too large to fit into the specified buffer and was truncated.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	276 * RNET_CONN_RESET The virtual circuit was reset by the remote side executing a "hard"
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	277 * or "abortive" close.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	278 * RNET_TIMEOUT The connection has been dropped, because of a
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	279 * network failure or because the system on the other end went down
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	280 * without notice.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	281 * RNET_NET_UNREACHABLE Remote host cannot be reached from this host at this time.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	282 * RNET_OK Data successfully read.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	283 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	284 T_RNET_RET rnet_rt_recv (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	285 T_RVF_BUFFER *buff,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	286 UINT16 * len_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	287
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	288 T_RNET_RET rnet_rt_recv_from (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	289 T_RVF_BUFFER * buff,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	290 UINT16 * len_p,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	291 T_RNET_IP_ADDR * from_addr,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	292 T_RNET_PORT * from_port);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	293
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	294 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	295 * Disables the sending on a socket and informs the peer
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	296 * about it.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	297 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	298 * Subsequent calls to the send function are disallowed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	299 * For TCP sockets, a FIN will be sent after all data is sent and acknowledged by the receiver.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	300 * The rnet_shutdown function does not frees the connection ID. Any resources attached
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	301 * to the ID will not be freed until rnet_close is invoked.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	302 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	303 * To assure that all data is sent and received on a connection (TCP) before it
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	304 * is closed, an application should use rnet_shutdown to close connection before calling
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	305 * rnet_close. For example, to initiate a graceful disconnect:
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	306 * 1) Call rnet_shutdown.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	307 * 2) When RNET_ERROR_IND with RNET_CONN_CLOSED is received, call rnet_recv until
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	308 * the len parameter is zero.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	309 * 3) Call rnet_close.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	310 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	311 * Following technique describes how to minimize the chance of problems
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	312 * occurring during connection teardown. In this example, the client is responsible for
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	313 * initiating a graceful shutdown.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	314 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	315 * Client Side Server Side
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	316 * (1) Invoke rnet_shutdown to
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	317 * signal end of session and that
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	318 * client has no more data to send.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	319 * (2) Receive RNET_ERROR_IND with RNET_CONN_CLOSED,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	320 * indicating graceful shutdown in progress
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	321 * and that all data has been received.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	322 * (3) Send any remaining response data with rnet_send.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	323 * (5') Get RNET_RECV_IND and (4) Invoke rnet_shutdown to
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	324 * invoke rnet_recv to get any indicate server has no more data to send.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	325 * response data sent by server.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	326 * (5) Receive RNET_ERROR_IND (4') Invoke rnet_close.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	327 * with RNET_CONN_CLOSED.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	328 * (6) Invoke rnet_close.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	329 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	330 * The timing sequence is maintained from step (1) to step (6) between the client and
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	331 * the server, except for step (4') and (5') which only has local timing significance in
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	332 * the sense that step (5) follows step (5') on the client side while step (4') follows
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	333 * step (4) on the server side, with no timing relationship with the remote party.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	334 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	335 * @param desc Connection identifier.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	336 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	337 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	338 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	339 * The descriptor is not connected (TCP only).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	340 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	341 * RNET_OK Connection shutdown, sending impossible
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	342 * RNET_ERROR_IND with the parameter RNET_CONN_CLOSED
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	343 * will be sent to the peer.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	344 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	345 T_RNET_RET rnet_rt_shutdown (T_RNET_DESC * desc);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	346
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	347 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	348 * Closes the connection.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	349 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	350 * Use it to release the connection ID so further references to it will fail with
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	351 * the error RNET_INVALID_PARAMETER.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	352 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	353 * An application should always have a matching call to rnet_close for each successful
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	354 * call to rnet_new to return any resources to the system.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	355 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	356 * The function may return RNET_MEMORY_ERR if no memory
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	357 * was available for closing the connection. If so, the application
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	358 * should wait and try again either by using the error message
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	359 * or the polling functionality.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	360 * If the close succeeds, the function returns RNET_OK.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	361 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	362 * The connection ID is deallocated after a call to rnet_close().
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	363 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	364 * @param desc Connection identifier.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	365 * @return RNET_MEMORY_ERR Not enough memory is available
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	366 * RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	367 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	368 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	369 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	370 * RNET_OK Socket closed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	371 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	372 T_RNET_RET rnet_rt_close (T_RNET_DESC * desc);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	373
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	374 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	375 * Gets the local address and port of a connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	376 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	377 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	378 * @param local_addr_p Local IP address [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	379 * @param local_port_p Local port [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	380 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	381 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	382 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	383 * or Not bound to an address with bind.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	384 * or ADDR_ANY is specified in bind but connection not yet occurred.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	385 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	386 * RNET_OK Local address/port successfully get.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	387 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	388 T_RNET_RET rnet_rt_get_local_addr_port (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	389 T_RNET_IP_ADDR * local_addr_p,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	390 T_RNET_PORT * local_port_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	391
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	392 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	393 * Use to determine the amount of data pending in the network's input buffer
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	394 * that can be read from the connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	395 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	396 * If desc is stream oriented (TCP), returns the amount of data that can be read
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	397 * in a single call to the rnet_recv function; this might not be the same as the
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	398 * total amount of data queued on the socket.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	399 * If desc is message oriented (UDP), returns the size of the first datagram
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	400 * (message) queued on the socket.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	401 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	402 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	403 * @param size_p Pointer to an unsigned int in which the result is stored [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	404 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	405 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	406 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	407 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	408 * RNET_OK Value successfully get.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	409 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	410 T_RNET_RET rnet_rt_get_buff_size (T_RNET_DESC * desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	411 UINT32 * size_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	412
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	413 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	414 * Requests host information corresponding to a host name or to a
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	415 * network address.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	416 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	417 * One of the two parameters name or addr must be NULL.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	418 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	419 * This function is bridge function sending a corresponding message to RNET.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	420 * The message RNET_HOST_INFO is sent back when the requested information
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	421 * is available.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	422 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	423 * Note that this function does not need a connection identifier and specifies
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	424 * its own return path.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	425 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	426 * @param name Name of the host to resolve [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	427 * @param addr Network address [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	428 * @param return_path Return path for sending the response.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	429 * @param user_data Pointer on some user-defined data that
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	430 * will be contained in the RNET_HOST_INFO message [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	431 * @return RNET_MEMORY_ERR Not enough memory is available.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	432 * RNET_OK The message could be correctly send.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	433 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	434 T_RNET_RET rnet_rt_get_host_info (char *name,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	435 T_RNET_IP_ADDR addr,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	436 T_RV_RETURN_PATH return_path,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	437 void * user_data);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	438
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	439 /*
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	440 * Following functions are not directly part of the networking API,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	441 * but they are used to retrieve some simple information from a connection
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	442 * descriptor. They are simple blocking functions, not sending any messages.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	443 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	444
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	445 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	446 * Retrieves the protocol associated to a connection descriptor.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	447 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	448 * @param desc Connection identifier.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	449 * @return A value of the T_RNET_IPPROTO enumeration.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	450 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	451 T_RNET_IPPROTO rnet_rt_get_proto (T_RNET_DESC *desc);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	452
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	453 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	454 * Associates an application specific pointer to a connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	455 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	456 * @param desc Connection identifier.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	457 * @param user_data Pointer that can be used by an application to store
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	458 * application specific data.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	459 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	460 void rnet_rt_set_user_data (T_RNET_DESC desc, void user_data);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	461
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	462 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	463 * Returns the application specific pointer associated to the connection ID.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	464 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	465 * @param desc Connection identifier.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	466 * @return Application specific data.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	467 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	468 void * rnet_rt_get_user_data (T_RNET_DESC *desc);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	469 /@}/
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	470
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	471 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	472 * Gets the maximum send size of a message.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	473 *
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	474 * @param desc Connection identifier [IN].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	475 * @param size_p Maximum send size [OUT].
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	476 * @return RNET_NOT_INITIALIZED NET subsystem not initialized (internal error).
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	477 * RNET_INTERNAL_ERR Network subsystem failed.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	478 * RNET_INVALID_PARAMETER The connection ID is invalid.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	479 * RNET_NOT_READY Still processing a callback function.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	480 * RNET_OK Local address/port successfully get.
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	481 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	482
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	483 T_RNET_RET rnet_rt_get_max_packet_size (T_RNET_DESC *desc,
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	484 UINT32 *size_p);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	485
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	486 /**
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	487 * NexGenIP specific API
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	488 */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	489
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	490 T_RNET_RET rnet_rt_route_add( T_RNET_IP_ADDR dest, T_RNET_IP_ADDR netmask, T_RNET_IP_ADDR gateway);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	491 T_RNET_RET rnet_rt_route_del( T_RNET_IP_ADDR dest);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	492 T_RNET_RET rnet_rt_route_default( T_RNET_IP_ADDR gateway);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	493
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	494 T_RNET_RET rnet_rt_if_setaddr( const char *ifname, T_RNET_IP_ADDR addr, T_RNET_IP_ADDR netmask);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	495 T_RNET_RET rnet_rt_if_getaddr( const char ifname, T_RNET_IP_ADDR addr, T_RNET_IP_ADDR *netmask);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	496 T_RNET_RET rnet_rt_if_setdstaddr( const char *ifname, T_RNET_IP_ADDR dstaddr);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	497 T_RNET_RET rnet_rt_if_getdstaddr( const char ifname, T_RNET_IP_ADDR dstaddr);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	498
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	499 T_RNET_RET rnet_rt_set_resolver( const char *domain, T_RNET_IP_ADDR dns1, T_RNET_IP_ADDR dns2);
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	500
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	501 #ifdef __cplusplus
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	502 }
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	503 #endif
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	504
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	505 #endif /__RNET_RT_API_H_/
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	506
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	507 #endif /* ifdef RNET_CFG_REAL_TRANSPORT */
d393cd9bb723 src/g23m-: initial import from Magnetite Mychaela Falconia <falcon@freecalypso.org>* parents: diff changeset	508

FreeCalypso > hg > fc-selenite

annotate src/g23m-fad/tcpip/rnet/rnet_rt/rnet_rt_api.h @ 204:027b22814ac4