rusefi
/
jSerialComm
mirror of https://github.com/rusefi/jSerialComm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

New SerialPortMessageListenerWithExceptions to allow users to handle event-based exceptions

This commit is contained in:
hedgecrw85 2020-01-03 13:50:55 -06:00
parent 05a84e4aff
commit 924bd97ad4
3 changed files with 59 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/main/java/com/fazecast/jSerialComm/SerialPort.java
View File

@ -2,10 +2,10 @@
* SerialPort.java
*
* Created on: Feb 25, 2012
* Last Updated on: Nov 04, 2019
* Last Updated on: Jan 03, 2020
* Author: Will Hedgecock
*
* Copyright (C) 2012-2019 Fazecast, Inc.
* Copyright (C) 2012-2020 Fazecast, Inc.
*
* This file is part of jSerialComm.
*
@ -50,7 +50,7 @@ import java.util.Date;
public final class SerialPort
{
// Static initializer loads correct native library for this machine
private static final String versionString = "2.5.3";
private static final String versionString = "2.5.4";
private static volatile boolean isAndroid = false;
private static volatile boolean isUnixBased = false;
private static volatile boolean isWindows = false;
@ -726,20 +726,22 @@ public final class SerialPort
* <p>
* Calling this function enables event-based serial port callbacks to be used instead of, or in addition to, direct serial port read/write calls or the {@link java.io.InputStream}/{@link java.io.OutputStream} interface.
* <p>
* The parameter passed into this method must be an implementation of either {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions}, {@link SerialPortPacketListener}, or {@link SerialPortMessageListener}.
* The {@link SerialPortMessageListener} interface <b>should</b> be used if you plan to use event-based reading of <i>delimited</i> data messages over the serial port.
* The parameter passed into this method must be an implementation of either {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions},
* {@link SerialPortPacketListener}, {@link SerialPortMessageListener} or {@link SerialPortMessageListenerWithExceptions}.
* The {@link SerialPortMessageListener} or {@link SerialPortMessageListenerWithExceptions} interface <b>should</b> be used if you plan to use event-based reading of <i>delimited</i> data messages over the serial port.
* The {@link SerialPortPacketListener} interface <b>should</b> be used if you plan to use event-based reading of <i>full</i> data packets over the serial port.
* Otherwise, the simpler {@link SerialPortDataListener} or {@link SerialPortDataListenerWithExceptions} may be used.
* <p>
* Only one listener can be registered at a time; however, that listener can be used to detect multiple types of serial port events.
* Refer to {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions}, {@link SerialPortPacketListener}, and {@link SerialPortMessageListener} for more information.
* Refer to {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions}, {@link SerialPortPacketListener}, {@link SerialPortMessageListener}, and {@link SerialPortMessageListenerWithExceptions} for more information.
*
* @param listener A {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions}, {@link SerialPortPacketListener}, or {@link SerialPortMessageListener} implementation to be used for event-based serial port communications.
* @param listener A {@link SerialPortDataListener}, {@link SerialPortDataListenerWithExceptions}, {@link SerialPortPacketListener}, {@link SerialPortMessageListener}, or {@link SerialPortMessageListenerWithExceptions} implementation to be used for event-based serial port communications.
* @return Whether the listener was successfully registered with the serial port.
* @see SerialPortDataListener
* @see SerialPortDataListenerWithExceptions
* @see SerialPortPacketListener
* @see SerialPortMessageListener
* @see SerialPortMessageListenerWithExceptions
*/
public final boolean addDataListener(SerialPortDataListener listener)
{
@ -1303,6 +1305,8 @@ public final class SerialPort
isListening = false;
if (userDataListener instanceof SerialPortDataListenerWithExceptions)
((SerialPortDataListenerWithExceptions)userDataListener).catchException(e);
else if (userDataListener instanceof SerialPortMessageListenerWithExceptions)
((SerialPortMessageListenerWithExceptions)userDataListener).catchException(e);
}
}
isListening = false;

2
src/main/java/com/fazecast/jSerialComm/SerialPortDataListenerWithExceptions.java
View File

@ -27,7 +27,7 @@ package com.fazecast.jSerialComm;
/**
* This interface must be implemented to enable simple event-based serial port I/O with a custom Exception callback.
*
*
* @author Will Hedgecock &lt;will.hedgecock@fazecast.com&gt;
* @version 2.5.4
* @see com.fazecast.jSerialComm.SerialPortDataListener

47
src/main/java/com/fazecast/jSerialComm/SerialPortMessageListenerWithExceptions.java Normal file
View File

@ -0,0 +1,47 @@
/*
* SerialPortMessageListenerWithExceptions.java
*
* Created on: Jan 03, 2020
* Last Updated on: Jan 03, 2020
* Author: Will Hedgecock
*
* Copyright (C) 2012-2020 Fazecast, Inc.
*
* This file is part of jSerialComm.
*
* jSerialComm is free software: you can redistribute it and/or modify
* it under the terms of either the Apache Software License, version 2, or
* the GNU Lesser General Public License as published by the Free Software
* Foundation, version 3 or above.
*
* jSerialComm is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of both the GNU Lesser General Public
* License and the Apache Software License along with jSerialComm. If not,
* see <http://www.gnu.org/licenses/> and <http://www.apache.org/licenses/>.
*/
package com.fazecast.jSerialComm;
/**
* This interface must be implemented to enable delimited message reads using event-based serial port I/O with a custom Exception callback.
* <p>
* <i>Note</i>: Using this interface will negate any serial port read timeout settings since they make no sense in an asynchronous context.
*
* @author Will Hedgecock &lt;will.hedgecock@fazecast.com&gt;
* @version 2.5.4
* @see com.fazecast.jSerialComm.SerialPortMessageListener
* @see com.fazecast.jSerialComm.SerialPortDataListener
* @see java.util.EventListener
*/
public interface SerialPortMessageListenerWithExceptions extends SerialPortMessageListener
{
/**
* Must be overridden to handle any Java exceptions that occur asynchronously in this data listener.
*
* @param e An {@link Exception} object containing information about the exception that occurred.
*/
public abstract void catchException(Exception e);
}