com.dkfqs.tools.lib

Class TCPSocket

java.lang.Object

com.dkfqs.tools.lib.TCPSocket

public class TCPSocket
extends java.lang.Object

Open a TCP/IP socket to a server.

Features:

• Measure the TCP/IP connect time (performance data)
• Support of TCP/IP connect timeout
• Support to set an outbound IP address

See Also:

EncryptedSocket

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TCP_CONNECT_TIMEOUT_MILLIS The default TCP connect timeout in milliseconds = 10000.

Constructor Summary

Constructors

Constructor and Description
TCPSocket(java.lang.String serverHost, int serverPort) Create a new instance with an unconnected socket.

Method Summary

Modifier and Type	Method and Description
java.net.Socket	connect() Connect the socket to the server.
long	getTCPConnectTime() Get the TCP/IP connect time for opening the network connection to the server.
void	setLocalOutboundAddress(java.net.InetAddress localOutboundAddress) Set a specific outbound IP address.
void	setTCPConnectTimeoutMillis(int tcpConnectTimeoutMillis) Set the TCP connect timeout.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TCP_CONNECT_TIMEOUT_MILLIS

public static final int DEFAULT_TCP_CONNECT_TIMEOUT_MILLIS

The default TCP connect timeout in milliseconds = 10000.

See Also:

Constant Field Values

Constructor Detail

TCPSocket

public TCPSocket(java.lang.String serverHost,
                 int serverPort)

Create a new instance with an unconnected socket.

Parameters:

serverHost - the hostname or IP address of the server

serverPort - the TPC/IP port of the server

See Also:

connect()

Method Detail

setTCPConnectTimeoutMillis

public void setTCPConnectTimeoutMillis(int tcpConnectTimeoutMillis)

Set the TCP connect timeout.

Parameters:

tcpConnectTimeoutMillis - the TCP connect timeout in milliseconds

See Also:

DEFAULT_TCP_CONNECT_TIMEOUT_MILLIS

setLocalOutboundAddress

public void setLocalOutboundAddress(java.net.InetAddress localOutboundAddress)

Set a specific outbound IP address.
Example: tcpSocket.setLocalOutboundAddress(InetAddress.getByName("192.168.0.100"));

Parameters:

localOutboundAddress - the specific outbound IP address

connect

public java.net.Socket connect()
                        throws java.io.IOException

Connect the socket to the server.

Returns:

the connected socket

Throws:

java.io.IOException - if somewhat fails

getTCPConnectTime

public long getTCPConnectTime()

Get the TCP/IP connect time for opening the network connection to the server.

Returns:

the TCP/IP connect time for opening the network connection to the server in milliseconds, or -1 if no such data is available