Extasys.Network.TCP.Client

Class ExtasysTCPClient

java.lang.Object

Extasys.Network.TCP.Client.ExtasysTCPClient

public class ExtasysTCPClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.util.concurrent.ThreadPoolExecutor	fMyThreadPool

Constructor Summary

Constructors

Constructor and Description
ExtasysTCPClient(java.lang.String name, java.lang.String description, int corePoolSize, int maximumPoolSize) Constructs a new Extasys TCP Client.

Method Summary

Methods

Modifier and Type	Method and Description
TCPConnector	AddConnector(java.lang.String name, java.net.InetAddress serverIP, int serverPort, int readBufferSize) Add a new connector to this client.
TCPConnector	AddConnector(java.lang.String name, java.net.InetAddress serverIP, int serverPort, int readBufferSize, char ETX) Add a new connector with message collector.
TCPConnector	AddConnector(java.lang.String name, java.net.InetAddress serverIP, int serverPort, int readBufferSize, java.lang.String splitter) Add a new connector with message collector.
void	Dispose() Dispose the client.
int	getBytesIn() Returns the total number of bytes received from all the connectors of the client.
int	getBytesOut() Returns the total number of bytes send from all the connectors of the client.
java.util.ArrayList	getConnectors() Return ArrayList with the client's connectors.
java.lang.String	getDescription() Return the description of the client.
java.util.concurrent.ThreadPoolExecutor	getMyThreadPool() Return the client's Thread Pool.
java.lang.String	getName() Return the name of the client.
void	OnConnect(TCPConnector connector) A connector of this client connected to a server.
void	OnDataReceive(TCPConnector connector, DataFrame data) A connector of this client receives data.
void	OnDisconnect(TCPConnector connector) A connector of this client has been disconnected.
void	RemoveConnector(java.lang.String name) Stop and remove a connector from this client.
void	SendData(byte[] bytes, int offset, int length) Send data from all connector's to all hosts.
void	SendData(java.lang.String data) Send data from all connector's to all hosts.
void	Start() Start or restart the client.
void	Stop() Stop the client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fMyThreadPool

public java.util.concurrent.ThreadPoolExecutor fMyThreadPool

Constructor Detail

ExtasysTCPClient

public ExtasysTCPClient(java.lang.String name,
                java.lang.String description,
                int corePoolSize,
                int maximumPoolSize)

Constructs a new Extasys TCP Client.

Parameters:

name - is the name of the client.

description - is the description of the client.

corePoolSize - is the number of threads to keep in the pool, even if they are idle.

maximumPoolSize - is the maximum number of threads to allow in the pool.

Method Detail

AddConnector

public TCPConnector AddConnector(java.lang.String name,
                        java.net.InetAddress serverIP,
                        int serverPort,
                        int readBufferSize)

Add a new connector to this client.

Parameters:

name - is the connector's name.

serverIP - is the remote host's (server) IP address.

serverPort - is the remote host's (server) port.

readBufferSize - is the read buffer size for this connection in bytes.

Returns:

the connector.

AddConnector

public TCPConnector AddConnector(java.lang.String name,
                        java.net.InetAddress serverIP,
                        int serverPort,
                        int readBufferSize,
                        char ETX)

Add a new connector with message collector.

Parameters:

name - is the connector's name.

serverIP - is the remote host's (server) IP address.

serverPort - is the remote host's (server) port.

readBufferSize - is the read buffer size for this connection in bytes.

ETX - is the End of Text character.

Returns:

the connector.

AddConnector

public TCPConnector AddConnector(java.lang.String name,
                        java.net.InetAddress serverIP,
                        int serverPort,
                        int readBufferSize,
                        java.lang.String splitter)

Add a new connector with message collector.

Parameters:

name - is the connector's name.

serverIP - is the remote host's (server) IP address.

serverPort - is the remote host's (server) port.

readBufferSize - is the read buffer size for this connection in bytes.

splitter - is the message splitter.

Returns:

the connector.

RemoveConnector

public void RemoveConnector(java.lang.String name)

Stop and remove a connector from this client.

Parameters:

name - is the connector's name.

Start

public void Start()
           throws java.lang.Exception

Start or restart the client.

Throws:

java.lang.Exception

Stop

public void Stop()

Stop the client.

Dispose

public void Dispose()

Dispose the client. This method stops the client and disposes all the active members of this class. After calling this method you cannot re-start the client.

SendData

public void SendData(java.lang.String data)
              throws ConnectorDisconnectedException,
                     ConnectorCannotSendPacketException

Send data from all connector's to all hosts.

Parameters:

data - is the string to be send.

Throws:

ConnectorDisconnectedException

ConnectorCannotSendPacketException

SendData

public void SendData(byte[] bytes,
            int offset,
            int length)
              throws ConnectorDisconnectedException,
                     ConnectorCannotSendPacketException

Send data from all connector's to all hosts.

Parameters:

bytes - is the byte array to be send.

offset - is the position in the data buffer at witch to begin sending.

length - is the number of the bytes to be send.

Throws:

ConnectorDisconnectedException

ConnectorCannotSendPacketException

OnDataReceive

public void OnDataReceive(TCPConnector connector,
                 DataFrame data)

A connector of this client receives data.

Parameters:

connector - is the client's connector.

data - is the received data.

OnConnect

public void OnConnect(TCPConnector connector)

A connector of this client connected to a server.

Parameters:

connector -

OnDisconnect

public void OnDisconnect(TCPConnector connector)

A connector of this client has been disconnected.

Parameters:

connector -

getName

public java.lang.String getName()

Return the name of the client.

Returns:

the name of the client.

getDescription

public java.lang.String getDescription()

Return the description of the client.

Returns:

the description of the client.

getConnectors

public java.util.ArrayList getConnectors()

Return ArrayList with the client's connectors. Each element of the ArrayList is a TCPConnector class.

Returns:

ArrayList with the client's connectors.

getMyThreadPool

public java.util.concurrent.ThreadPoolExecutor getMyThreadPool()

Return the client's Thread Pool.

Returns:

the client's Thread Pool.

getBytesIn

public int getBytesIn()

Returns the total number of bytes received from all the connectors of the client.

Returns:

the number of bytes received from all the connectors of the client.

getBytesOut

public int getBytesOut()

Returns the total number of bytes send from all the connectors of the client.

Returns:

the total number of bytes send from all the connectors of the client.