Interface SerialPortMessageListener

All Superinterfaces:
EventListener, SerialPortDataListener
All Known Subinterfaces:
SerialPortMessageListenerWithExceptions

public interface SerialPortMessageListener extends SerialPortDataListener
This interface must be implemented to enable delimited message reads using event-based serial port I/O.

Note: Using this interface will negate any serial port read timeout settings since they make no sense in an asynchronous context.

See Also:
  • Method Details

    • getMessageDelimiter

      byte[] getMessageDelimiter()
      Must be overridden to return the expected message delimiter bytes that must be encountered before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.
      Returns:
      A byte array containing the expected message delimiters that must be encountered before the SerialPortDataListener.serialEvent(SerialPortEvent) callback is triggered.
    • delimiterIndicatesEndOfMessage

      boolean delimiterIndicatesEndOfMessage()
      Must be overridden to return whether the message delimiter indicates the end or the beginning of a message.
      Returns:
      A boolean indicating whether the message delimiter indicates the end or the beginning of a message.