com.iizix.comm.client

Class ClientInstance

java.lang.Object

com.iizix.comm.client.ClientInstance

public class ClientInstance
extends Object

The client class for communication with a remote server over (secured) WebSocket using the iizi reconnectable transactional processing.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug mode, very verbose output.

Constructor Summary

Constructors

Constructor and Description
ClientInstance(PropFactory propFactory, String host, int port, String wsURI, SSLCommProps sslProps, IClientInstanceListener clientListener) Constructor.

Method Summary

Modifier and Type	Method and Description
void	connect() Connects to the WebSocket URI with or without SSL.
void	connect(boolean noTimeouts) Connects to the WebSocket URI with or without SSL.
boolean	dispose() Disposes of this instance and closes the communication session (if opened).
String	getInfoString() Gets the info string of this session.
String	getState() Gets the state as a String.
boolean	isConnected() Checks if connected.
boolean	isDisconnected() Checks if disconnected.
void	sendBinaryData(int id, String descr, byte[] data) Sends a block of binary data to the remote party.
String	toString() The String representation as "host:port - description".

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Debug mode, very verbose output.

Constructor Detail

ClientInstance

public ClientInstance(PropFactory propFactory,
                      String host,
                      int port,
                      String wsURI,
                      SSLCommProps sslProps,
                      IClientInstanceListener clientListener)
               throws IOException,
                      UnrecoverableKeyException,
                      KeyManagementException,
                      NoSuchAlgorithmException,
                      CertificateException,
                      KeyStoreException,
                      NoSuchProviderException

Constructor.

Parameters:

propFactory - The property factory.

host - The host name or address.

port - The port number.

wsURI - The relative WebSocket URI starting with "/" (normally ending with .ws [unsecure] or .wss [secure]).

sslProps - The SSL properties, null for not secure.

clientListener - The client listener.

Throws:

IOException - For I/O errors.

NoSuchProviderException

KeyStoreException

CertificateException

NoSuchAlgorithmException

KeyManagementException

UnrecoverableKeyException

Method Detail

isConnected

public boolean isConnected()

Checks if connected.

isDisconnected

public boolean isDisconnected()

Checks if disconnected.

getState

public String getState()

Gets the state as a String.

Returns:

"Connecting", "Connected", "Disconnecting" or "Disconnected".

connect

public void connect()
             throws IOException

Connects to the WebSocket URI with or without SSL.

Throws:

IllegalStateException - If already connected or connecting.

IOException - For communication problems.

connect

public void connect(boolean noTimeouts)
             throws IOException

Connects to the WebSocket URI with or without SSL.

Parameters:

noTimeouts - Connect with debug = no timeouts! This way we can set breakpoints in Eclipse.

Throws:

IllegalStateException - If already connected or connecting.

IOException - For communication problems.

dispose

public boolean dispose()

Disposes of this instance and closes the communication session (if opened). The web socket connection is closed with the close code "1000" = "Normal close". This root property is disposed of.

Returns:

true for success, false if already disposed of.

sendBinaryData

public void sendBinaryData(int id,
                           String descr,
                           byte[] data)
                    throws IOException

Sends a block of binary data to the remote party.

Parameters:

id - The ID of the reply local ID for error or success reply.

descr - Short description of the data.

data - The data.

Throws:

EOFException - If connection is closed.

IOException - For send failures.

getInfoString

public String getInfoString()

Gets the info string of this session.

Returns:

Same as SessionInfo.getConnectionIDString(info).

toString

public String toString()

The String representation as "host:port - description".

Overrides:

toString in class Object

Returns:

Same as SessionInfo.getConnectionIDString(info).