LTX_utils.h File Reference

LTX library, contains the public interface to initialization routines for LTX utilities. More...

Functions
int	LTX_HwReport (int type)
	Runs the hardware reporting mechanism.
int	LTX_SwReport (void)
	Runs the software reporting mechanism.
int	LTX_Initialize (int tx_port, int rx_port, int msg)
	Initializes the socket server.
int	LTX_Shutdown (void)
	Shuts down the socket server.

---

Detailed Description

LTX library, contains the public interface to initialization routines for LTX utilities.

Author:

S.Maldonado - smaldona@slac.stanford.edu

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

---

Function Documentation

int LTX_HwReport

(

int

type

)

Runs the hardware reporting mechanism.

Routine calling PCI bus scan.

Parameters:

	type	Integer type of hardware report.
	type	Specifies print only type report

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References LTX_ERR, LTX_NUM_BUSES, and LTX_OK.

int LTX_Initialize	(	int	tx_port,
		int	rx_port,
		int	msg
	)

Initializes the socket server.

Intialize socket and data structures.

Parameters:

	tx_port	The transmit socket port number
	rx_port	The receive socket port number
	msg	FLag to enable message printing
	tx_port	The transmit socket port number.
	rx_port	The receive socket port number.
	msg	Flag to enable message printing

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References _LTX_server_config::cmdRxExit, LTX_ERR, LTX_OK, LTX_serverInit(), LTX_serverSizeof(), LTX_TASK_ID, LTX_TASK_PRI, _LTX_server_config::rx_port, svr, and _LTX_server_config::tx_port.

int LTX_Shutdown

(

void

)

Shuts down the socket server.

Close socket and free memory.

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References _LTX_server_config::cmdRxExit, LTX_ERR, LTX_OK, LTX_serverClose(), and svr.

int LTX_SwReport

(

void

)

Runs the software reporting mechanism.

Routine calling CMX asBuilt functions.

Return values:

	LTX_OK	Success.
	LTX_ERR	Failure.

References LTX_dataSend(), LTX_ERR, LTX_OK, LTX_SOCK_BUFSIZE, LTX_STR_SIZE, and svr.