sila_java.library.communication

Class SynchronousCommunication

java.lang.Object

sila_java.library.communication.SynchronousCommunication

All Implemented Interfaces:

AutoCloseable

public class SynchronousCommunication
extends Object
implements AutoCloseable

Serial Communication Class Keeps connection alive and synchronises send & receive calls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SynchronousCommunication.Builder Builder
static interface	SynchronousCommunication.CheckResultInterface Check result interface

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isUp() Is communication up
void	open() Open the Serial Port
List<String>	read(long timeout) Read with timeout
List<String>	read(long timeout, @NonNull String receiveDelimiter) Directly read from the serial port in case of asynchronous inputs
List<String>	sendReceive(String msg, long timeout) Send and Receive Messages over Serial Port synchronously
String	sendReceiveSingleLine(String msg, long timeout) Send and Receive Messages when a single line response is expected
void	startHeartbeat(int samplingTime, @NonNull Supplier<Boolean> connectionTester) Start Heartbeat that probes the connection and reestablishes it

Methods inherited from class java.lang.Object

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

Method Detail

startHeartbeat

public void startHeartbeat(int samplingTime,
                           @NonNull
                           @NonNull Supplier<Boolean> connectionTester)

Start Heartbeat that probes the connection and reestablishes it

Parameters:

samplingTime - Minimum time interval to check if connection is up

connectionTester - Boolean check that indicates if connection nis healthy

close

public void close()

Specified by:

close in interface AutoCloseable

Implementation Note:

Stops heartbeat by means of an interruption signal. Upon Interrupted Exception, the heartbeat will then clean this object - No need to closeStreams everywhere else

open

public void open()
          throws IOException

Open the Serial Port

Throws:

IOException

Implementation Note:

Currently using fixed Settings, change API when necessary

isUp

public boolean isUp()

Is communication up

Returns:

true if the communication is up

sendReceiveSingleLine

public String sendReceiveSingleLine(String msg,
                                    long timeout)
                             throws IOException

Send and Receive Messages when a single line response is expected

Parameters:

msg - Message to serialse and send

timeout - timeout Timeout in [ms]

Returns:

Single Line, otherwise Throws Exception

Throws:

IOException

sendReceive

public List<String> sendReceive(String msg,
                                long timeout)
                         throws IOException

Send and Receive Messages over Serial Port synchronously

Parameters:

msg - Message to serialise and send

timeout - Timeout in [ms]

Returns:

The answer from the serial port split in line breaks

Throws:

IOException

read

public List<String> read(long timeout)
                  throws IOException

Read with timeout

Parameters:

timeout - the timeout

Returns:

read result

Throws:

IOException

read

public List<String> read(long timeout,
                         @NonNull
                         @NonNull String receiveDelimiter)
                  throws IOException

Directly read from the serial port in case of asynchronous inputs

Parameters:

timeout - Timeout in [ms]

Returns:

The answer from the serial port split in line breaks

Throws:

IOException