---

modtcpLib.c File Reference

This file contains several utility functions for opening and closing socket connections used in the modtcp driver. More...

Defines
#define	logMsg   printf
#define	INVALID_SOCKET   (-1)
#define	ERROR   (-1)
Functions
socket_Error_t	modtcpsocketCreate (char *name, int tcpPort, char *inet_address)
	Adds a new socket connection description to an internal linked list.
SOCKET_ID	modtcpsocketOpen (char *name)
	Returns the ID for the given socket ID device.
int	modtcpSocketReport ()
	Lists all sockets and their information.
void	modtcpPrint (char *prefix, char *data, int len)
	Utility tool to display data packet to or from PLC.
int	modtcpConnect (SOCKET_ID pSock)
	Creates the socket connection to the PLC using the predefined socket structure.
int	modtcpSend (SOCKET_ID pSock, char *request, int len)
	Writes the passed string to the specified socket.
int	modtcpRcv (SOCKET_ID pSock, char *response)
	Reads the response from the specified socket.
void	modtcpDisconnect (SOCKET_ID pSock)
	Closes the connection of the passed socket structure.
Variables
int	modtcpDebug = 0
SOCKET_ID	pFirst = NULL

---

Detailed Description

This file contains several utility functions for opening and closing socket connections used in the modtcp driver.

---

Define Documentation

#define ERROR   (-1)

#define INVALID_SOCKET   (-1)

#define logMsg   printf

---

Function Documentation

int modtcpConnect (  SOCKET_ID    pSock )

Creates the socket connection to the PLC using the predefined socket structure. Parameters: pSock  the SOCKET_ID structure

void modtcpDisconnect (  SOCKET_ID    pSock )

Closes the connection of the passed socket structure. Parameters: pSock  the socket ID

void modtcpPrint (  char *    prefix, char *    data, int    len )

Utility tool to display data packet to or from PLC.

int modtcpRcv (  SOCKET_ID    pSock, char *    response )

Reads the response from the specified socket. Parameters: pSock  the socket ID response  the string containing the message Returns: result of the send

int modtcpSend (  SOCKET_ID    pSock, char *    request, int    len )

Writes the passed string to the specified socket. Parameters: pSock  the socket ID request  the string containing the message len  the length of the message Returns: result of the send

socket_Error_t modtcpsocketCreate (  char *    name, int    tcpPort, char *    inet_address )

Adds a new socket connection description to an internal linked list. Test for duplicate socket structures, and initialize the socket information. The sockets are not created or opened here, See also: modtcpConnect(). Parameters: name  the local name for the target plc tcpPort  the port to be used for the connection. For Modicon systems this is typically 502. inet_address  a decimal-dot string containing the IP address Returns: SOCKET_nameExists if there is already a socket with the passed name SOCKET_alloc if an error occurrs allocating memory for the socket structure SOCKET_OK on success

SOCKET_ID modtcpsocketOpen (  char *    name )

Returns the ID for the given socket ID device. Searches through the list of devices and returns an identifier for the specified socket name. Parameters: name  the local name for the target plc Returns: A valid SOCKET_ID, or NULL if no such device exists.

int modtcpSocketReport (    )

Lists all sockets and their information.

---

Variable Documentation

int modtcpDebug = 0

SOCKET_ID pFirst = NULL [static]

---