org.openmuc.jsml.transport

Class TSAP

java.lang.Object

org.openmuc.jsml.transport.TSAP

public class TSAP
extends java.lang.Object

This class implements the SML Transport Layer Service Access Point (TSAP) for the use of SML over TCP/IP. It can be used by a client to create SML_TConnections as well as by a Server to listen for SML_TConnections

Constructor Summary

Constructors

Constructor and Description
TSAP() Use this constructor to create a client SML_TSAP that can be used to start a connection to a remote SML server.
TSAP(int port, TConnectionListener conListener) Use this constructor to create a server TSAP that can listen on a port.
TSAP(int port, TConnectionListener conListener, javax.net.ServerSocketFactory serverSocketFactory) Use this constructor to create a server TSAP that can listen on a port, with a specified ServerSocketFactory.
TSAP(javax.net.SocketFactory socketFactory) Use this constructor to create a client SML_TSAP that can be used to start a connection to a remote SML server.

Method Summary

Modifier and Type	Method and Description
TConnection	connectTo(java.net.InetAddress address, int port, int timeout) Connect to a remote TSAP that is listening at the destination address.
protected TConnectionListener	getConnectionListener()
void	setMaxConnections(int maxConnections) Set the maximum number of connections that are allowed in parallel by the Server SAP.
void	setMessageFragmentTimeout(int messageFragmentTimeout) Set the TConnection timeout for receiving data once the beginning of a message has been received.
void	setMessageTimeout(int messageTimeout) Set the TConnection timeout for waiting for the first byte of a new message.
void	startListening() Starts a new thread that listens on the configured port.
void	stopListening() Stop listing on the port.

Methods inherited from class java.lang.Object

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

Constructor Detail

TSAP

public TSAP()

Use this constructor to create a client SML_TSAP that can be used to start a connection to a remote SML server.

TSAP

public TSAP(javax.net.SocketFactory socketFactory)

Use this constructor to create a client SML_TSAP that can be used to start a connection to a remote SML server. You could pass an SSLSocketFactory to enable SSL.

Parameters:

socketFactory - the socket factory

TSAP

public TSAP(int port,
            TConnectionListener conListener)

Use this constructor to create a server TSAP that can listen on a port.

Parameters:

port - the TCP-port that the ServerSocket will connect to. Should be between 1 and 65535.

conListener - the ConnectionListener that will be notified when remote TSAPs are connecting or the server stopped listening.

TSAP

public TSAP(int port,
            TConnectionListener conListener,
            javax.net.ServerSocketFactory serverSocketFactory)

Use this constructor to create a server TSAP that can listen on a port, with a specified ServerSocketFactory.

Parameters:

port - the TCP-port that the ServerSocket will connect to. Should be between 1 and 65535.

conListener - the ConnectionListener that will be notified when remote TSAPs are connecting or the server stopped listening.

serverSocketFactory - The ServerSocketFactory to be used to create the ServerSocket

Method Detail

startListening

public void startListening()
                    throws java.io.IOException

Starts a new thread that listens on the configured port. This method is non-blocking.

Throws:

java.io.IOException - if an error occurs starting to listen on server port

stopListening

public void stopListening()

Stop listing on the port. Stops the server thread.

setMaxConnections

public void setMaxConnections(int maxConnections)

Set the maximum number of connections that are allowed in parallel by the Server SAP.

Parameters:

maxConnections - the number of connections allowed (default is 100)

setMessageTimeout

public void setMessageTimeout(int messageTimeout)

Set the TConnection timeout for waiting for the first byte of a new message. Default is 0 (unlimited)

Parameters:

messageTimeout - in milliseconds

setMessageFragmentTimeout

public void setMessageFragmentTimeout(int messageFragmentTimeout)

Set the TConnection timeout for receiving data once the beginning of a message has been received. Default is 2000 (2seconds)

Parameters:

messageFragmentTimeout - in milliseconds

getConnectionListener

protected TConnectionListener getConnectionListener()

connectTo

public TConnection connectTo(java.net.InetAddress address,
                             int port,
                             int timeout)
                      throws java.io.IOException

Connect to a remote TSAP that is listening at the destination address.

Parameters:

address - remote InetAddress

port - remote port

timeout - timeout

Returns:

the connection object

Throws:

java.io.IOException - if connection was unsuccessful.