LTX_server.h File Reference

LTX socket server. TCP/IP sockets are used to communicate data to LTX host application. More...

Classes
struct	_LTX_server_config
Defines
#define	LTX_OK   0
	Return ok status.
#define	LTX_ERR   1
	Return error status.
Typedefs
typedef struct _LTX_server	LTX_server
typedef struct _LTX_server_config	LTX_server_config
Functions
Server Control Functions
int	LTX_serverSizeof (void)
	Get the size of a server descriptor.
int	LTX_serverInit (LTX_server *lc, LTX_server_config *lcfg, int msg)
	Intialize a server.
int	LTX_serverClose (LTX_server *lc)
	Shutdown server.
int	LTX_dataSend (LTX_server *lc, void *buf, int size)
	Send data to client.
int	LTX_dataRecv (LTX_server *lc, void *buf, int size)
	Receive data from client.

---

Detailed Description

LTX socket server. TCP/IP sockets are used to communicate data to LTX host application.

Author:

S. Maldonado

   CVS $Id: LTX_server.h,v 1.2 2003/11/10 17:42:43 smaldona Exp $
   

---

Typedef Documentation

LTX_server

Socket server descriptor.

LTX_server_config

The typedef for _LTX_server_config.

---

Function Documentation

int LTX_dataRecv	(	LTX_server *	lc,
		void *	buf,
		int	size
	)

Receive data from client.

Received data from the LTX host

Parameters:

	lc	The server handle.
	buf	The data buffer.
	size	The size of data to receive

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References LTX_ERR, LTX_sockRead(), and _LTX_server::rx_data.

int LTX_dataSend	(	LTX_server *	lc,
		void *	buf,
		int	size
	)

Send data to client.

Sends data to the LTX host

Parameters:

	lc	The server handle.
	buf	The data buffer.
	size	The size of the data to send

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References LTX_ERR, LTX_sockWrite(), and _LTX_server::tx_data.

int LTX_serverClose

(

LTX_server *

lc

)

Shutdown server.

Stops socket connection

Parameters:

lc

A server descriptor.

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References LTX_ERR, LTX_OK, _LTX_server::rx_data, _LTX_server::rx_socket, _LTX_server::tx_data, and _LTX_server::tx_socket.

int LTX_serverInit	(	LTX_server *	lc,
		LTX_server_config *	lcfg,
		int	msg
	)

Intialize a server.

Intializes the socket descriptor and server software.

Parameters:

	lc	An uninitialized socket descriptor.
	lcfg	The handle to the server config object.
	msg	Flag to enable message printing

Return values:

	LTX_OK	Success.
	LTX_ERR	Error.

References LTX_ERR, LTX_OK, _LTX_server::rx_data, _LTX_server_config::rx_port, _LTX_server::rx_socket, _LTX_server::tx_data, _LTX_server_config::tx_port, and _LTX_server::tx_socket.

int LTX_serverSizeof

(

void

)

Get the size of a server descriptor.

Returns the size of a socket server descriptor. The user is responsible for allocating this memory before calling.

Returns:

The size in bytes of the descriptor.