001/* A listener for TokenGotEvents from an IOPort.
002
003 Copyright (c) 2007-2014 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.actor;
029
030//////////////////////////////////////////////////////////////////////////
031//// TokenGotListener
032
033/**
034 A TokenGotListener listens for events that are issued during the
035 get(),  and getInside() function calls of an IOPort.  In
036 general, an object that implements this interface will be collecting
037 tokens for storage.
038 <p>
039 Currently this class is being used in Kepler by the
040 ProvenanceExecutionListener for saving tokens with provenance
041 information.  In the future, listeners will use this interface
042 to save tokens in a cache for use during "smart" reruns or for
043 fault tolerance.
044
045 @author Oscar Barney
046 @version $Id$
047 @since Ptolemy II 6.1
048 @deprecated Use IOPortEventListener instead.
049 @Pt.ProposedRating Red (barney)
050 @Pt.AcceptedRating
051 @see IOPort
052 */
053@Deprecated
054public interface TokenGotListener {
055
056    /** Report an that a token was received with get().  This method
057     *  will be called when a token has been taken from the port's
058     *  queue at an input IOPort.
059     *  @param event The event to report.
060     */
061    public void tokenGotEvent(TokenGotEvent event);
062}