ch.aplu.tcpcom

Class TCPClient

java.lang.Object

ch.aplu.tcpcom.TCPClient

public class TCPClient
extends java.lang.Object

Class to create a TCP client socket handled by event callbacks.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTED State value
static java.lang.String	CONNECTING State value
static java.lang.String	CONNECTION_FAILED State value
static java.lang.String	DISCONNECTED State value
static java.lang.String	MESSAGE State value
static java.lang.String	SERVER_OCCUPIED State value

Constructor Summary

Constructors

Constructor and Description
TCPClient(java.lang.String host, int port) Same, but isVerbose = false
TCPClient(java.lang.String host, int port, boolean isVerbose) Creates a TCP socket client prepared for a connection with a TCPServer at given address and port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTCPClientListener(TCPClientListener listener) Registers a TCPClientListener to get state change notifications.
boolean	connect() Same as connect(int timeout) with system default timeout.
boolean	connect(int timeout) Creates a connection to the server (blocking until timeout).
void	disconnect() Closes the connection with the server.
static java.lang.String	getVersion() Returns the library version.
boolean	isConnected() Returns true if client is connected to a server.
boolean	isConnecting() Returns true during a connection trial.
void	sendMessage(java.lang.String msg) Same as sendMessage(String msg, int responseTime) with responseTime = 0.
java.lang.String	sendMessage(java.lang.String msg, int responseTime) Sends the information msg to the server (as String, the character \0 (ASCII 0) serves as end of string indicator, it is transparently added and removed).

Methods inherited from class java.lang.Object

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

Field Detail

CONNECTING

public static java.lang.String CONNECTING

State value

SERVER_OCCUPIED

public static java.lang.String SERVER_OCCUPIED

State value

CONNECTION_FAILED

public static java.lang.String CONNECTION_FAILED

State value

CONNECTED

public static java.lang.String CONNECTED

State value

DISCONNECTED

public static java.lang.String DISCONNECTED

State value

MESSAGE

public static java.lang.String MESSAGE

State value

Constructor Detail

TCPClient

public TCPClient(java.lang.String host,
         int port,
         boolean isVerbose)

Creates a TCP socket client prepared for a connection with a TCPServer at given address and port. State changes invoke the callback onStateChanged().

Parameters:

host - the IP address of the host

port - the IP port where to listen (0..65535)

isVerbose - if true, debug messages are written to System.out

TCPClient

public TCPClient(java.lang.String host,
         int port)

Same, but isVerbose = false

Parameters:

host - the IP address of the host

port - the IP port where to listen (0..65535)

Method Detail

addTCPClientListener

public void addTCPClientListener(TCPClientListener listener)

Registers a TCPClientListener to get state change notifications.

Parameters:

listener - the listener to register

connect

public boolean connect(int timeout)

Creates a connection to the server (blocking until timeout).

Parameters:

timeout - the maximum time (in s) for the connection trial (0: for default timeout)

Returns:

true, if the connection is established; false, if the server is not available or occupied

connect

public boolean connect()

Same as connect(int timeout) with system default timeout.

Returns:

true, if the connection is established; false, if the server is not available or occupied

isConnecting

public boolean isConnecting()

Returns true during a connection trial.

Returns:

true, while the client tries to connect

isConnected

public boolean isConnected()

Returns true if client is connected to a server.

Returns:

true, if the connection is established

disconnect

public void disconnect()

Closes the connection with the server.

sendMessage

public java.lang.String sendMessage(java.lang.String msg,
                           int responseTime)

Sends the information msg to the server (as String, the character \0 (ASCII 0) serves as end of string indicator, it is transparently added and removed). For responseTime > 0 the method blocks and waits for maximum responseTime seconds for a server reply.

Parameters:

msg - the message to send

responseTime - the maximum time to wait for a server reply (in s)

Returns:

the message or null, if a timeout occured

sendMessage

public void sendMessage(java.lang.String msg)

Same as sendMessage(String msg, int responseTime) with responseTime = 0.

Parameters:

msg - the message to send

getVersion

public static java.lang.String getVersion()

Returns the library version.

Returns:

the current version of the library