se.entra.phantom.server

Interface ClientCommunicationInterface

All Superinterfaces:

SocketNameInterface

All Known Implementing Classes:

HttpSession, HttpTunnelingCommunication, SocketClientCommunication, WebSocketClientCommunication

public interface ClientCommunicationInterface
extends SocketNameInterface

The manager for all threaded client sessions that clients can connect to.

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes an open client connection.
InetAddress	getClientInetAddress() Gets the address of the client.
InetAddress	getServerInetAddress() Gets the address of the server.
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 an open client connection without flushing potential data.
byte[]	receiveTransaction() Reads a transaction from the client.
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 interface se.entra.phantom.server.SocketNameInterface

getClientDNSName, getClientIPAddress

Method Detail

getClientInetAddress

InetAddress getClientInetAddress()

Gets the address of the client.

getServerInetAddress

InetAddress getServerInetAddress()

Gets the address of the server.

receiveTransaction

byte[] receiveTransaction()
                   throws IOException

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

Throws:

IOException

receiveTransaction

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

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

Throws:

IOException

sendTransaction

void sendTransaction(byte[] data)
              throws IOException

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

Throws:

IOException

sendTransaction

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).

Throws:

IOException

close

boolean close()

Closes an open client connection.

Returns:

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

hardClose

void hardClose()

Hard-closes an open client connection without flushing potential data.

getSocket

ISocket getSocket()

Gets socket associated with this communication.

Returns:

null if no socket is available.

getServerSocket

ServerSocketInterface getServerSocket()

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

Returns:

null if no server socket is available.