Package eu.mihosoft.devcom

Class StreamConnection<T>

java.lang.Object

eu.mihosoft.devcom.StreamConnection<T>

All Implemented Interfaces:

DataConnection<T,StreamConnection<T>>, AutoCloseable

public final class StreamConnection<T>
extends Object
implements DataConnection<T,StreamConnection<T>>

Stream connection for reading and writing data from/to io streams.

Nested Class Summary

Nested classes/interfaces inherited from interface eu.mihosoft.devcom.DataConnection

DataConnection.Subscription

Constructor Summary

Constructors

Constructor	Description
StreamConnection(DataFormat<T> format)	Creates a new connection instance.
StreamConnection(DataFormat<T> format, Consumer<StreamConnection<T>> onConnectionOpened, BiConsumer<StreamConnection<T>,Exception> onIOError)	Creates a new connection instance.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection to the specified port.
DataFormat<T>	getFormat()	Returns the data format used by this connection.
boolean	isOpen()	Indicates whether this connection is currently open.
void	open()	Opens the specified port and connects to it.
void	open(InputStream inputStream, OutputStream outputStream)	Opens the specified port and connects to it.
DataConnection.Subscription	registerConnectionClosedListener(Consumer<DataConnection<T,?>> l)	Registers a listener that is notified whenever the connection is closed.
DataConnection.Subscription	registerConnectionOpenedListener(Consumer<DataConnection<T,?>> l)	Registers a listener that is notified whenever the connection is opened.
DataConnection.Subscription	registerDataListener(Consumer<T> l)	Registers a data listener that is notified whenever a message has been received.
DataConnection.Subscription	registerIOErrorListener(BiConsumer<DataConnection<T,?>,Exception> l)	Registers a listener that is notified whenever an I/O error occurees.
void	setOnConnectionClosed(Consumer<DataConnection<T,?>> onConnectionClosed)
StreamConnection<T>	setOnConnectionOpened(Consumer<StreamConnection<T>> onConnectionOpened)	Specifies the action to be performed if the connection has been opened.
StreamConnection<T>	setOnDataReceived(Consumer<T> onDataReceived)	Sets the action to be executed if data has been received.
StreamConnection<T>	setOnIOError(BiConsumer<StreamConnection<T>,Exception> onIOError)	Specifies the action to be performed if an I/O error occurs.
StreamConnection<T>	setStreams(InputStream inputStream, OutputStream outputStream)	Sets the configuration to use for connecting to a port.
void	writeData(T msg)	Writes the specified raw message to the output stream.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamConnection

public StreamConnection(DataFormat<T> format)

Creates a new connection instance.

Parameters:

format - the data format to use for communication

StreamConnection

public StreamConnection(DataFormat<T> format,
 Consumer<StreamConnection<T>> onConnectionOpened,
 BiConsumer<StreamConnection<T>,Exception> onIOError)

Creates a new connection instance.

Parameters:

onConnectionOpened - task to be executed if the selected COM-port has been successfully opened

onIOError - task to be executed if an io error has occurred

Method Details

setOnDataReceived

public StreamConnection<T> setOnDataReceived(Consumer<T> onDataReceived)

Description copied from interface: DataConnection

Sets the action to be executed if data has been received.

Specified by:

setOnDataReceived in interface DataConnection<T,StreamConnection<T>>

Parameters:

onDataReceived - consumer to be called if data has been received

setOnIOError

public StreamConnection<T> setOnIOError(BiConsumer<StreamConnection<T>,Exception> onIOError)

Description copied from interface: DataConnection

Specifies the action to be performed if an I/O error occurs.

Specified by:

setOnIOError in interface DataConnection<T,StreamConnection<T>>

Parameters:

onIOError - the action to be performed if an I/O error occurs

setOnConnectionOpened

public StreamConnection<T> setOnConnectionOpened(Consumer<StreamConnection<T>> onConnectionOpened)

Specifies the action to be performed if the connection has been opened.

Parameters:

onConnectionOpened - the action to be performed if the connection has been opened

registerDataListener

public DataConnection.Subscription registerDataListener(Consumer<T> l)

Description copied from interface: DataConnection

Registers a data listener that is notified whenever a message has been received.

Specified by:

registerDataListener in interface DataConnection<T,StreamConnection<T>>

Parameters:

l - the data listener to register

Returns:

a subscription that allows a listener to be unsubscribed

registerConnectionOpenedListener

public DataConnection.Subscription registerConnectionOpenedListener(Consumer<DataConnection<T,?>> l)

Description copied from interface: DataConnection

Registers a listener that is notified whenever the connection is opened.

Specified by:

registerConnectionOpenedListener in interface DataConnection<T,StreamConnection<T>>

Parameters:

l - the data listener to register

Returns:

a subscription that allows a listener to be unsubscribed

registerConnectionClosedListener

public DataConnection.Subscription registerConnectionClosedListener(Consumer<DataConnection<T,?>> l)

Description copied from interface: DataConnection

Registers a listener that is notified whenever the connection is closed.

Specified by:

registerConnectionClosedListener in interface DataConnection<T,StreamConnection<T>>

Parameters:

l - the data listener to register

Returns:

a subscription that allows a listener to be unsubscribed

registerIOErrorListener

public DataConnection.Subscription registerIOErrorListener(BiConsumer<DataConnection<T,?>,Exception> l)

Description copied from interface: DataConnection

Registers a listener that is notified whenever an I/O error occurees.

Specified by:

registerIOErrorListener in interface DataConnection<T,StreamConnection<T>>

Parameters:

l - the data listener to register

Returns:

a subscription that allows a listener to be unsubscribed

open

public void open(InputStream inputStream,
 OutputStream outputStream)

Opens the specified port and connects to it.

Parameters:

inputStream - input stream to be used by this connection

outputStream - output stream to be used by this connection

setStreams

public StreamConnection<T> setStreams(InputStream inputStream,
 OutputStream outputStream)

Sets the configuration to use for connecting to a port.

Parameters:

inputStream - the input stream to be used by this connection

outputStream - the output stream to be used by this connection

Returns:

this connection

open

public void open()

Opens the specified port and connects to it.

Specified by:

open in interface DataConnection<T,StreamConnection<T>>

writeData

public void writeData(T msg)
               throws IOException

Description copied from interface: DataConnection

Writes the specified raw message to the output stream.

Specified by:

writeData in interface DataConnection<T,StreamConnection<T>>

Parameters:

msg - the message to send

Throws:

IOException - if an i/o error occurs during message sending

close

public void close()

Closes the connection to the specified port.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface DataConnection<T,StreamConnection<T>>

setOnConnectionClosed

public void setOnConnectionClosed(Consumer<DataConnection<T,?>> onConnectionClosed)

Specified by:

setOnConnectionClosed in interface DataConnection<T,StreamConnection<T>>

getFormat

public DataFormat<T> getFormat()

Description copied from interface: DataConnection

Returns the data format used by this connection.

Specified by:

getFormat in interface DataConnection<T,StreamConnection<T>>

Returns:

the data format used by this connection

isOpen

public boolean isOpen()

Description copied from interface: DataConnection

Indicates whether this connection is currently open.

Specified by:

isOpen in interface DataConnection<T,StreamConnection<T>>

Returns:

true if this connection is currently open; false otherwise