01: /*
02: * Copyright (c) 2001 by Matt Welsh and The Regents of the University of
03: * California. All rights reserved.
04: *
05: * Permission to use, copy, modify, and distribute this software and its
06: * documentation for any purpose, without fee, and without written agreement is
07: * hereby granted, provided that the above copyright notice and the following
08: * two paragraphs appear in all copies of this software.
09: *
10: * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
11: * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
12: * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
13: * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14: *
15: * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
16: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
17: * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
18: * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
19: * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
20: *
21: * Author: Matt Welsh <mdw@cs.berkeley.edu>
22: *
23: */
24:
25: package seda.sandStorm.api;
26:
27: /**
28: * This event indicates that a sink has closed, either intentionally
29: * by the application, or unintentionally, due to an error condition.
30: * A sink is considered closed when it is no longer being serviced.
31: *
32: * <p>As opposed to SinkClosedException (which is thrown immediately
33: * if one tries to enqueue onto a closed sink), this event is pushed
34: * to a stage if a sink closes asynchronously (that is, without being
35: * requested by the application), or some time after the original
36: * enqueue occurred.
37: *
38: * @see SinkClosedException
39: * @author Matt Welsh
40: */
41: public class SinkClosedEvent implements QueueElementIF {
42:
43: /**
44: * The sink that closed.
45: */
46: public SinkIF sink;
47:
48: /**
49: * Create a new SinkClosedEvent with the given sink.
50: */
51: public SinkClosedEvent(SinkIF sink) {
52: this .sink = sink;
53: }
54:
55: public String toString() {
56: return "SinkClosedEvent [sink=" + sink + "]";
57: }
58: }
|