org.arl.fjage.connectors

Class TcpHubConnector

java.lang.Object

java.lang.Thread

org.arl.fjage.connectors.TcpHubConnector

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Runnable, Connector

public class TcpHubConnector
extends java.lang.Thread
implements Connector

TCP hub server. All incoming connections to the TCP server are aggregated into a single connector. All data in/out of the input/output streams of this connector are common across all TCP clients.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<org.arl.fjage.connectors.TcpHubConnector.ClientThread>	clientThreads
protected ConnectionListener	listener
protected java.util.logging.Logger	log
protected org.arl.fjage.connectors.TcpHubConnector.OutputThread	outThread
protected PseudoInputStream	pin
protected int	port
protected PseudoOutputStream	pout
protected java.net.ServerSocket	sock
protected boolean	telnet

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TcpHubConnector(int port) Creates a TCP server running on a specified port.
TcpHubConnector(int port, boolean telnet) Creates a TCP server running on a specified port.

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown the TCP server.
java.lang.String[]	connections() Gets a list of all known active connections
java.io.InputStream	getInputStream() Get the input stream to read data over.
java.io.OutputStream	getOutputStream() Get the output stream to write data to.
int	getPort() Get the TCP port on which the server listens for connections.
boolean	isReliable() Check if a connection is relaible.
void	run()
void	setConnectionListener(ConnectionListener listener) Set a connection state listener.
java.lang.String	toString()
boolean	waitOutputCompletion(long timeout) Wait until the output buffer is empty.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.arl.fjage.connectors.Connector

getName

Field Detail

port

protected int port

telnet

protected boolean telnet

sock

protected java.net.ServerSocket sock

outThread

protected org.arl.fjage.connectors.TcpHubConnector.OutputThread outThread

clientThreads

protected final java.util.List<org.arl.fjage.connectors.TcpHubConnector.ClientThread> clientThreads

log

protected java.util.logging.Logger log

pin

protected PseudoInputStream pin

pout

protected PseudoOutputStream pout

listener

protected ConnectionListener listener

Constructor Detail

TcpHubConnector

public TcpHubConnector(int port,
                       boolean telnet)

Creates a TCP server running on a specified port.

Parameters:

port - TCP port number (0 to autoselect).

telnet - true to negotiate character mode using telnet protocol, false to leave the choice to the client.

Throws:

java.io.UncheckedIOException - if the port cannot be bound (e.g. already in use).

TcpHubConnector

public TcpHubConnector(int port)

Creates a TCP server running on a specified port.

Parameters:

port - TCP port number (0 to autoselect).

Throws:

java.io.UncheckedIOException - if the port cannot be bound (e.g. already in use).

Method Detail

getPort

public int getPort()

Get the TCP port on which the server listens for connections.

close

public void close()

Shutdown the TCP server.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface Connector

isReliable

public boolean isReliable()

Description copied from interface: Connector

Check if a connection is relaible. A reliable connection throws an exception if data written to the output stream cannot be delivered.

Specified by:

isReliable in interface Connector

waitOutputCompletion

public boolean waitOutputCompletion(long timeout)

Description copied from interface: Connector

Wait until the output buffer is empty.

Specified by:

waitOutputCompletion in interface Connector

Parameters:

timeout - timeout in milliseconds.

Returns:

true if output buffer empty, false on timeout or error.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

getInputStream

public java.io.InputStream getInputStream()

Description copied from interface: Connector

Get the input stream to read data over.

Specified by:

getInputStream in interface Connector

getOutputStream

public java.io.OutputStream getOutputStream()

Description copied from interface: Connector

Get the output stream to write data to.

Specified by:

getOutputStream in interface Connector

setConnectionListener

public void setConnectionListener(ConnectionListener listener)

Description copied from interface: Connector

Set a connection state listener.

Specified by:

setConnectionListener in interface Connector

Parameters:

listener - listener to call for connection/disconnection, or null to disable listener.

connections

public java.lang.String[] connections()

Description copied from interface: Connector

Gets a list of all known active connections

Specified by:

connections in interface Connector

Returns:

an array of all known active connections

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Thread