Source code

001/* Marker interface for receivers that have state semantics.
002
003 Copyright (c) 2004-2006 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//// StateReceiver
032
033/**
034 This is a marker interface for receivers that have <i>state</i> semantics.
035 That is, whenever a get method is called on this receiver, the
036 current token is always available and returned. Further more, if
037 no put method is called between get methods, the returned tokens are
038 always the same. Usually, the receivers that implement this interface
039 have capacity of 1.
040 <p>
041 Receivers that do not implement this marker interface have <i>event</i>
042 semantics, which means that when a get method is called on the receiver,
043 the current token is returned and it is also removed from the receiver.
044
045 @author Haiyang Zheng
046 @version $Id$
047 @since Ptolemy II 4.1
048 @Pt.ProposedRating Yellow (hyzheng)
049 @Pt.AcceptedRating Red (hyzheng)
050 */
051public interface StateReceiver {
052}