XPortConnection Class Reference

#include <XPort.h>

List of all members.

---

Detailed Description

Encapsulates configuration parameters associated with a Lantronix XPort terminal server.

The XPort has a serial port and a number of GPIO pins that may be configured as inputs or outputs, active high or low. XPort configuration and control is done via a TCP/IP socket connections. XPortConnection is used to store and manage these TCP/IP socket connections.

Public Member Functions
	XPortConnection ()
	Default no argument constructor.
	XPortConnection (char *host, unsigned int gPort, unsigned int sPort, unsigned int dMask, unsigned int dValues, unsigned int lMask, unsigned int lValues)
	Initializing constructor.
int	configAll (char *host, unsigned int serialIPPort, unsigned int gpioIPPort, unsigned int dirMask, unsigned int dirValues, unsigned int levelMask, unsigned int levelValues)
	Configure all connection parameters.
int	configHost (char *hostName)
	Configure host TCP/IP address.
int	configGPIO (int gpioIPPort, unsigned int dirMask, unsigned int dirValues, unsigned int levelMask, unsigned int levelValues)
	Configure GPIO connection parameters.
int	configSerial (int serialIPPort)
	Configure serial TCP/IP port parameters.
void	setsdGPIO (int sd)
	Set GPIO socket descriptor.
void	setsdSerial (int sd)
	Set serial socket descriptor.
char *	getHost ()
	Returns: XPort host TCP/IP address/name
unsigned int	getpGPIO ()
	Returns: GPIO TCP/IP port
unsigned int	getpSerial ()
	Returns: Serial TCP/IP port
int	getsdGPIO ()
	Returns: GPIO TCP/IP socket descriptor
int	getsdSerial ()
	Returns: Serial TCP/IP socket descriptor
unsigned int	getDirMask ()
	Returns: GPIO pin direction control mask
unsigned int	getDirValues ()
	Returns: GPIO pin direction values mask
unsigned int	getLevelMask ()
	Returns: GPIO pin level control mask
unsigned int	getLevelValues ()
	Returns: GPIO pin level values mask
Private Attributes
char *	host
	XPort TCP/IP host name/address string.
int	gpioPort
	XPort GPIO TCP/IP port.
int	serialPort
	XPort Serial TCP/IP port.
unsigned int	dirMask
	XPort GPIO direction control mask.
unsigned int	levelMask
	XPort GPIO level control mask.
unsigned int	dirValues
	XPort GPIO direction values (state) mask.
unsigned int	levelValues
	XPort GPIO level values (state) mask.
int	sdGPIO
	XPort GPIO TCP/IP socket descriptor.
int	sdSERIAL
	XPort Serial TCP/IP socket descriptor.
Friends
ostream &	operator<< (ostream &output, const XPortConnection &n)
	output stream operator.

---

Constructor & Destructor Documentation

XPortConnection::XPortConnection

(

)

Default no argument constructor.

XPortConnection::XPortConnection	(	char *	host,
		unsigned int	gpioIPPort,
		unsigned int	serialIPPort,
		unsigned int	dirMask,
		unsigned int	dirValues,
		unsigned int	levelMask,
		unsigned int	levelValues
	)

Initializing constructor.

Parameters:

	host	XPort host name
	gpioIPPort	TCP/IP port to use for GPIO
	serialIPPort	TCP/IP port to use for serial IO
	dirMask	GPIO direction pin-select mask
	dirValues	GPIO initial direction values mask
	levelMask	GPIO level pin-select mask
	levelValues	GPIO initial level (state) values mask

---

Member Function Documentation

int XPortConnection::configAll	(	char *	host,
		unsigned int	gpioIPPort,
		unsigned int	serialIPPort,
		unsigned int	dirMask,
		unsigned int	dirValues,
		unsigned int	levelMask,
		unsigned int	levelValues
	)

Configure all connection parameters.

Parameters:

	host	XPort host name
	gpioIPPort	TCP/IP port to use for GPIO
	serialIPPort	TCP/IP port to use for serial IO
	dirMask	GPIO direction pin-select mask
	dirValues	GPIO initial direction values mask
	levelMask	GPIO level pin-select mask
	levelValues	GPIO initial level (state) values mask

Returns:

OK;

int XPortConnection::configHost

(

char *

hostName

)

Configure host TCP/IP address.

Parameters:

hostName

XPort host name

Returns:

OK;

int XPortConnection::configGPIO	(	int	gPort,
		unsigned int	dMask,
		unsigned int	dValues,
		unsigned int	lMask,
		unsigned int	lValues
	)

Configure GPIO connection parameters.

Parameters:

	gPort	TCP/IP port to use for GPIO
	dMask	GPIO direction pin-select mask
	dValues	GPIO initial direction values mask
	lMask	GPIO level pin-select mask
	lValues	GPIO initial level (state) values mask

Returns:

OK;

int XPortConnection::configSerial

(

int

sPort

)

Configure serial TCP/IP port parameters.

Parameters:

sPort

TCP/IP port to use for serial IO

Returns:

OK;

void XPortConnection::setsdGPIO

(

int

sd

)

Set GPIO socket descriptor.

Parameters:

sd

socket descriptor

void XPortConnection::setsdSerial

(

int

sd

)

Set serial socket descriptor.

Parameters:

sd

socket descriptor

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	output,
		const XPortConnection &	n
	)			[friend]

output stream operator.

Formats object for output stream insertion

Parameters:

	output	output stream handle
	n	Field object pointer

---

The documentation for this class was generated from the following files:

• camera/XPort.h
• camera/XPort.cc

---