sila_java.library.communication

Class SynchronousCommunication.Builder

java.lang.Object

sila_java.library.communication.SynchronousCommunication.Builder

Enclosing class:

SynchronousCommunication

public static class SynchronousCommunication.Builder
extends Object

Builder

Constructor Summary

Constructors

Constructor and Description
Builder(@NonNull CommunicationSocket communicationSocket) Builder

Method Summary

Modifier and Type	Method and Description
SynchronousCommunication	build() Build SynchronousCommunication
SynchronousCommunication.Builder	withErrorChecker(SynchronousCommunication.CheckResultInterface errorCheckerFunction) Errors caught on the message layer, be sure to catch the whole error message to empty the input buffers.
SynchronousCommunication.Builder	withReceiveDelimiter(@NonNull String receiveDelimiter)
SynchronousCommunication.Builder	withSendDelimiter(@NonNull String sendDelimiter)
SynchronousCommunication.Builder	withStartupMessageFlusher(@NonNull WelcomeFlusherFunction startupFunction) Some connections send startup messages that need to be flushed, so this will assign a runnable to the startupFunction.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@NonNull
               @NonNull CommunicationSocket communicationSocket)

Builder

Parameters:

communicationSocket - Communication Socket that will be handled by this class

Method Detail

withSendDelimiter

public SynchronousCommunication.Builder withSendDelimiter(@NonNull
                                                          @NonNull String sendDelimiter)

Parameters:

sendDelimiter - Delimiter used to mark end of sent messages

withReceiveDelimiter

public SynchronousCommunication.Builder withReceiveDelimiter(@NonNull
                                                             @NonNull String receiveDelimiter)

Parameters:

receiveDelimiter - Delimiter used to mark end of received messages

withStartupMessageFlusher

public SynchronousCommunication.Builder withStartupMessageFlusher(@NonNull
                                                                  @NonNull WelcomeFlusherFunction startupFunction)

Some connections send startup messages that need to be flushed, so this will assign a runnable to the startupFunction.

Parameters:

startupFunction - Start function that is triggered on every reconnection

withErrorChecker

public SynchronousCommunication.Builder withErrorChecker(SynchronousCommunication.CheckResultInterface errorCheckerFunction)

Errors caught on the message layer, be sure to catch the whole error message to empty the input buffers. Recommendation: Only use this if errors lead to different receive delimiters than in normal operation, otherwise its safer to check for errors after reading has executed.

Parameters:

errorCheckerFunction - Function that throws IOException or derivative on detected error.

build

public SynchronousCommunication build()

Build SynchronousCommunication

Returns:

a new SynchronousCommunication instance