001package com.pi4j.io.serial;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  SerialDataEventListener.java
009 *
010 * This file is part of the Pi4J project. More information about
011 * this project can be found here:  https://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2019 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 *
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 *
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032
033/**
034 * <p> This interface implements the callback event handler for Serial Data events. </p>
035 *
036 * <p>
037 * Before using the Pi4J library, you need to ensure that the Java VM in configured with access to
038 * the following system libraries:
039 * <ul>
040 * <li>pi4j</li>
041 * <li>wiringPi</li>
042 * </ul>
043 * <blockquote> This library depends on the wiringPi native system library.</br> (developed by
044 * Gordon Henderson @ <a href="http://wiringpi.com/">http://wiringpi.com/</a>)
045 * </blockquote>
046 * </p>
047 *
048 * @see com.pi4j.io.serial.SerialFactory
049 * @see com.pi4j.io.serial.Serial
050 * @see com.pi4j.io.serial.SerialDataEvent
051 *
052 * @see <a href="https://www.pi4j.com/">https://www.pi4j.com/</a>
053 * @author Robert Savage (<a
054 *         href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
055 */
056public interface SerialDataEventListener extends java.util.EventListener {
057
058    /**
059     * This is the event callback method that will be invoked when new serial data is received.
060     *
061     * @see com.pi4j.io.serial.SerialDataEvent
062     * @param event serial data event
063     */
064    void dataReceived(SerialDataEvent event);
065}