org.eclipse.basyx.components.netcomm

Class TCPCommunicator

java.lang.Object

org.eclipse.basyx.components.netcomm.TCPCommunicator

Direct Known Subclasses:

TCPClient, TCPServer

public abstract class TCPCommunicator
extends Object

Base class for NIO based TCP communication Communication messages consist of a 32 Bit value that describes message length (bytes), followed by message length bytes with payload.

Author:

kuhn

Constructor Summary

Constructors

Constructor and Description
TCPCommunicator()

Method Summary

Modifier and Type	Method and Description
Selector	addCommunicationSocket(Selector selector) Add communication socket (the one that transmits/receives data) to given selector
void	addTCPMessageListener(NetworkReceiver addedListener) Add a TCP message listener
void	close() Close communication
Selector	getSelector() Get a selector.
byte[]	readMessage() Read message from client
String	readStringMessage() Read message from client as string
void	removeTCPMessageListener(NetworkReceiver addedListener) Remove a TCP message listener
void	sendMessage(byte[] message) Send message to client
void	sendMessage(ByteBuffer messageBuffer) Send message to client Buffer must point to where transmission should start
void	sendMessage(String message) Send message to client
static String	toString(byte[] value) Convert byte array to string

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPCommunicator

public TCPCommunicator()

Method Detail

toString

public static String toString(byte[] value)

Convert byte array to string

addCommunicationSocket

public Selector addCommunicationSocket(Selector selector)

Add communication socket (the one that transmits/receives data) to given selector

Returns:

The selector, same as input parameter

getSelector

public Selector getSelector()

Get a selector. This socket will not be added to the selector.

sendMessage

public void sendMessage(byte[] message)

Send message to client

sendMessage

public void sendMessage(String message)

Send message to client

sendMessage

public void sendMessage(ByteBuffer messageBuffer)

Send message to client Buffer must point to where transmission should start

readMessage

public byte[] readMessage()

Read message from client

readStringMessage

public String readStringMessage()

Read message from client as string

close

public void close()

Close communication

addTCPMessageListener

public void addTCPMessageListener(NetworkReceiver addedListener)

Add a TCP message listener

removeTCPMessageListener

public void removeTCPMessageListener(NetworkReceiver addedListener)

Remove a TCP message listener