se.entra.phantom.client

Class RemoteSocket

java.lang.Object

se.entra.phantom.client.RemoteSocket

public class RemoteSocket
extends Object

Class handling a remote socket open on the server side.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
String	host The destination host.
int	port The destination port.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the socket.
IOException	completeOpen() Waits for the open operation to complete and returns a possible exception.
IOException	getException() Gets the exception that occurred on the tunneled socket of the server.
byte[]	getInputData() Gets a buffer of data from the tunneled socket of the server.
boolean	hasInputData() Checks if there is any unread data present from the tunneled socket of the server.
boolean	isOpened() Checks if the socket is opened, successfully or with an exception.
void	registerInputNotification(IRemoteSocket notifier) Registers a notification interface when data is received at the remote server input stream of the socket.
void	write(byte[] buf, int offset, int count) Write data to the socket output stream.

Methods inherited from class java.lang.Object

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

Field Detail

host

public final String host

The destination host.

port

public final int port

The destination port.

Method Detail

isOpened

public boolean isOpened()

Checks if the socket is opened, successfully or with an exception.

completeOpen

public IOException completeOpen()

Waits for the open operation to complete and returns a possible exception.

Returns:

An IOException if an error occurred, null for success.

registerInputNotification

public void registerInputNotification(IRemoteSocket notifier)

Registers a notification interface when data is received at the remote server input stream of the socket.

Parameters:

notifier - The notification interface.

hasInputData

public boolean hasInputData()

Checks if there is any unread data present from the tunneled socket of the server.

Make sure to also check for error using getException().

Returns:

true if data is present. Even if the socket is closed, there might be unread data.

getInputData

public byte[] getInputData()

Gets a buffer of data from the tunneled socket of the server.

Make sure to also check for error using getException().

Returns:

An byte buffer of the data, null if none is available. Even if the socket is closed, unread data may be present.

getException

public IOException getException()

Gets the exception that occurred on the tunneled socket of the server.

Returns:

An IOException or null for no error.

write

public void write(byte[] buf,
                  int offset,
                  int count)
           throws IOException

Write data to the socket output stream.

Parameters:

buf - The byte buffer.

offset - The position in the byte buffer.

count - Count of bytes to write.

Throws:

IOException - If the socket is closed.

close

public void close()

Closes the socket.