org.arl.fjage.connectors

Interface Connector

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

SerialPortConnector, TcpConnector, TcpHubConnector, WebSocketConnector, WebSocketHubConnector

public interface Connector
extends java.io.Closeable

Any data transport service implemets this interface.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
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.lang.String	getName() Get a string representation of the connection.
java.io.OutputStream	getOutputStream() Get the output stream to write data to.
boolean	isReliable() Check if a connection is relaible.
void	setConnectionListener(ConnectionListener listener) Set a connection state listener.
boolean	waitOutputCompletion(long timeout) Wait until the output buffer is empty.

Method Detail

getName

java.lang.String getName()

Get a string representation of the connection.

getInputStream

java.io.InputStream getInputStream()

Get the input stream to read data over.

getOutputStream

java.io.OutputStream getOutputStream()

Get the output stream to write data to.

isReliable

boolean isReliable()

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

waitOutputCompletion

boolean waitOutputCompletion(long timeout)

Wait until the output buffer is empty.

Parameters:

timeout - timeout in milliseconds.

Returns:

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

setConnectionListener

void setConnectionListener(ConnectionListener listener)

Set a connection state listener.

Parameters:

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

connections

java.lang.String[] connections()

Gets a list of all known active connections

Returns:

an array of all known active connections

close

void close()

Close the connection.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable