com.netphantom.server.ws

Class WebSocketClientCommunication

java.lang.Object

com.netphantom.server.ws.WebSocketClientCommunication

All Implemented Interfaces:

ClientCommunicationInterface, SocketNameInterface

public class WebSocketClientCommunication
extends Object
implements ClientCommunicationInterface

This class communicates with the client over WebSocket. Each client has an instance of this class.

Constructor Summary

Constructors

Constructor and Description
WebSocketClientCommunication(ServerSocketInterface serverSocket, WebSocketServer wsServer) The instance of this class is created by the client connection listener.

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes the current socket connection to the client.
String	getClientDNSName() Gets the DNS name of this client connection.
InetAddress	getClientInetAddress() Gets the address of the client or null if not connected.
String	getClientIPAddress() Gets the IP address of this client connection (as 1.2.3.4), or return "0.0.0.0" if disconnected and the address never has been retrieved.
InetAddress	getServerInetAddress() Gets the address of the server or null if not connected.
ServerSocketInterface	getServerSocket() Gets the server socket interface associated with the accept of this socket.
ISocket	getSocket() Gets socket associated with this communication.
void	hardClose() Hard-closes the current socket connection to the client.
byte[]	receiveTransaction() Deprecated.
byte[]	receiveTransaction(Object[] isCompressed) Reads a transaction from the client.
void	sendTransaction(byte[] data) Sends a transaction to the client.
void	sendTransaction(byte[] data, int type) Sends a transaction to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketClientCommunication

public WebSocketClientCommunication(ServerSocketInterface serverSocket,
                                    WebSocketServer wsServer)

The instance of this class is created by the client connection listener.

Method Detail

getClientInetAddress

public InetAddress getClientInetAddress()

Gets the address of the client or null if not connected.

Specified by:

getClientInetAddress in interface ClientCommunicationInterface

getServerInetAddress

public InetAddress getServerInetAddress()

Gets the address of the server or null if not connected.

Specified by:

getServerInetAddress in interface ClientCommunicationInterface

getClientDNSName

public String getClientDNSName()

Gets the DNS name of this client connection. A return value of "null" indicates that there is no DNS name found.

Specified by:

getClientDNSName in interface SocketNameInterface

getClientIPAddress

public String getClientIPAddress()

Gets the IP address of this client connection (as 1.2.3.4), or return "0.0.0.0" if disconnected and the address never has been retrieved.

Specified by:

getClientIPAddress in interface SocketNameInterface

receiveTransaction

@Deprecated
public byte[] receiveTransaction()
                                       throws IOException

Deprecated.

Reads a transaction from the client. This call is blocking until the transaction has been read.

This method is deprecated and receiveTransaction(Object [] isCompressed) should be used instead.

Specified by:

receiveTransaction in interface ClientCommunicationInterface

Returns:

null if the socket is closed.

Throws:

IOException

receiveTransaction

public byte[] receiveTransaction(Object[] isCompressed)
                          throws IOException

Reads a transaction from the client. This call is blocking until the transaction has been read.

Specified by:

receiveTransaction in interface ClientCommunicationInterface

Returns:

null if the socket is closed.

Throws:

IOException

sendTransaction

public void sendTransaction(byte[] data)
                     throws IOException

Sends a transaction to the client. This call is blocking until the transaction has been sent.

Specified by:

sendTransaction in interface ClientCommunicationInterface

Throws:

IOException

sendTransaction

public void sendTransaction(byte[] data,
                            int type)
                     throws IOException

Sends a transaction to the client. This call is blocking until the transaction has been sent. The type of message to send is 0=uncompressed binary, 1=compressed binary and 2=UTF-8 text (for WebSocket).

Specified by:

sendTransaction in interface ClientCommunicationInterface

Throws:

IOException

close

public boolean close()

Closes the current socket connection to the client.

Specified by:

close in interface ClientCommunicationInterface

Returns:

true if the close operation completed with flushing potential data, false otherwise.

hardClose

public void hardClose()

Hard-closes the current socket connection to the client.

Specified by:

hardClose in interface ClientCommunicationInterface

getSocket

public ISocket getSocket()

Gets socket associated with this communication.

Specified by:

getSocket in interface ClientCommunicationInterface

Returns:

null if no socket is available.

getServerSocket

public ServerSocketInterface getServerSocket()

Gets the server socket interface associated with the accept of this socket.

Specified by:

getServerSocket in interface ClientCommunicationInterface

Returns:

null if no server socket is available.