001/**
002 * Copyright (c) 2014-2015 Digi International Inc.,
003 * All rights not expressly granted are reserved.
004 *
005 * This Source Code Form is subject to the terms of the Mozilla Public
006 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
007 * You can obtain one at http://mozilla.org/MPL/2.0/.
008 *
009 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
010 * =======================================================================
011 */
012package com.digi.xbee.api.listeners;
013
014import com.digi.xbee.api.packet.XBeePacket;
015
016/**
017 * This interface defines the required methods that an object should implement
018 * to behave as a packet listener and be notified when new packets are received 
019 * from a remote XBee device of the network.
020 */
021public interface IPacketReceiveListener {
022
023        /**
024         * Called when an XBee packet is received through the connection interface.
025         * 
026         * @param receivedPacket The received XBee packet.
027         * 
028         * @see com.digi.xbee.api.packet.XBeePacket
029         * @see com.digi.xbee.api.packet.XBeeAPIPacket
030         */
031        public void packetReceived(XBeePacket receivedPacket);
032}