ch.aplu.tcpcom

Class TCPServer

java.lang.Object

java.lang.Thread

ch.aplu.tcpcom.TCPServer

All Implemented Interfaces:

java.lang.Runnable

public class TCPServer
extends java.lang.Thread

Class to create a TCP server socket handled by event callbacks.

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
static java.lang.String	CONNECTED State value
static java.lang.String	LISTENING State value
static java.lang.String	MESSAGE State value
static java.lang.String	PORT_IN_USE State value
static java.lang.String	TERMINATED State value

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
TCPServer(int port) Same with isVerbose = false.
TCPServer(int port, boolean isVerbose) Creates a TCP socket server that listens on TCP port for a connecting client.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTCPServerListener(TCPServerListener listener) Registers a TCPServerListener to get state change notifications.
void	disconnect() Closes the connection with the client and enters the LISTENING state.
static java.lang.String	getVersion() Returns the library version.
boolean	isConnected() Returns true, if a client is connected to the server.
boolean	isTerminated() Returns true, if the server is in TERMINATED state.
void	run() For internal use only
void	sendMessage(java.lang.String msg) Sends the information msg to the client (as String, the character \0 (ASCII 0) serves as end of string indicator, it is transparently added and removed)
void	terminate() Closes the connection and terminates the server thread.

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, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

PORT_IN_USE

public static java.lang.String PORT_IN_USE

State value

CONNECTED

public static java.lang.String CONNECTED

State value

LISTENING

public static java.lang.String LISTENING

State value

TERMINATED

public static java.lang.String TERMINATED

State value

MESSAGE

public static java.lang.String MESSAGE

State value

Constructor Detail

TCPServer

public TCPServer(int port,
         boolean isVerbose)

Creates a TCP socket server that listens on TCP port for a connecting client. The server runs in its own thread, so the constructor returns immediately. State changes invoke the callback onStateChanged().

Parameters:

port - the IP port where to listen (0..65535)

isVerbose - if true, debug messages are written to System.out

TCPServer

public TCPServer(int port)

Same with isVerbose = false.

Parameters:

port - the IP port where to listen (0..65535)

Method Detail

run

public void run()

For internal use only

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

addTCPServerListener

public void addTCPServerListener(TCPServerListener listener)

Registers a TCPServerListener to get state change notifications.

Parameters:

listener - the listener to register

isConnected

public boolean isConnected()

Returns true, if a client is connected to the server.

Returns:

true, if the communication link is establed

disconnect

public void disconnect()

Closes the connection with the client and enters the LISTENING state.

terminate

public void terminate()

Closes the connection and terminates the server thread. Releases the IP port.

isTerminated

public boolean isTerminated()

Returns true, if the server is in TERMINATED state.

Returns:

true, if the server thread is terminated

sendMessage

public void sendMessage(java.lang.String msg)

Sends the information msg to the client (as String, the character \0 (ASCII 0) serves as end of string indicator, it is transparently added and removed)

Parameters:

msg - the message to send

getVersion

public static java.lang.String getVersion()

Returns the library version.

Returns:

the current version of the library