70 lines
3.2 KiB
Java
70 lines
3.2 KiB
Java
/*
|
|
* SerialPortDataListener.java
|
|
*
|
|
* Created on: Feb 25, 2015
|
|
* Last Updated on: Jan 03, 2018
|
|
* Author: Will Hedgecock
|
|
*
|
|
* Copyright (C) 2012-2018 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;
|
|
|
|
import java.util.EventListener;
|
|
|
|
/**
|
|
* This interface must be implemented to enable simple event-based serial port I/O.
|
|
*
|
|
* @author Will Hedgecock <will.hedgecock@fazecast.com>
|
|
* @version 2.0.0
|
|
* @see java.util.EventListener
|
|
*/
|
|
public interface SerialPortDataListener extends EventListener
|
|
{
|
|
/**
|
|
* Must be overridden to return one or more desired event constants for which the {@link #serialEvent(SerialPortEvent)} callback should be triggered.
|
|
* <p>
|
|
* Valid event constants are:
|
|
* <p>
|
|
* {@link SerialPort#LISTENING_EVENT_DATA_AVAILABLE}<br>
|
|
* {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED}<br>
|
|
* {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}<br>
|
|
* <p>
|
|
* Two or more events may be OR'd together to listen for multiple events; however, if {@link SerialPort#LISTENING_EVENT_DATA_AVAILABLE} is OR'd with {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED}, the {@link SerialPort#LISTENING_EVENT_DATA_RECEIVED} flag will take precedence.
|
|
* <p>
|
|
* Note that event-based <i>write</i> callbacks are only supported on Windows operating systems. As such, the {@link SerialPort#LISTENING_EVENT_DATA_WRITTEN}
|
|
* event will never be called on a non-Windows system.
|
|
*
|
|
* @return The event constants that should trigger the {@link #serialEvent(SerialPortEvent)} callback.
|
|
* @see SerialPort#LISTENING_EVENT_DATA_AVAILABLE
|
|
* @see SerialPort#LISTENING_EVENT_DATA_RECEIVED
|
|
* @see SerialPort#LISTENING_EVENT_DATA_WRITTEN
|
|
*/
|
|
public abstract int getListeningEvents();
|
|
|
|
/**
|
|
* Called whenever one of the serial port events specified by the {@link #getListeningEvents()} method occurs.
|
|
* <p>
|
|
* Note that your implementation of this function should always perform as little data processing as possible, as the speed at which this callback will fire is at the mercy of the underlying operating system. If you need to collect a large amount of data, application-level buffering should be implemented and data processing should occur on a separate thread.
|
|
*
|
|
* @param event A {@link SerialPortEvent} object containing information and/or data about the serial event that occurred.
|
|
* @see SerialPortEvent
|
|
*/
|
|
public abstract void serialEvent(SerialPortEvent event);
|
|
}
|