01: /* ====================================================================
02: The Jicarilla Software License
03:
04: Copyright (c) 2003 Leo Simons.
05: All rights reserved.
06:
07: Permission is hereby granted, free of charge, to any person obtaining
08: a copy of this software and associated documentation files (the
09: "Software"), to deal in the Software without restriction, including
10: without limitation the rights to use, copy, modify, merge, publish,
11: distribute, sublicense, and/or sell copies of the Software, and to
12: permit persons to whom the Software is furnished to do so, subject to
13: the following conditions:
14:
15: The above copyright notice and this permission notice shall be
16: included in all copies or substantial portions of the Software.
17:
18: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19: EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
21: IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22: CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23: TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24: SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25: ==================================================================== */
26: package org.jicarilla.plumbing;
27:
28: /**
29: * <p>Broadcasts a message to multiple sinks. All messages sent to the
30: * Multicaster will be sent to all the sinks it is linked to. In diagram
31: * form:</p>
32: *
33: * <pre>
34: * +-------------+
35: * |Multicaster |
36: * addSink() | +---------+|
37: * ------> |/-|Sink ||
38: * || +---------+|
39: * || +---------+|
40: * put() / offer() --->-|Sink ||
41: * || +---------+|
42: * || +---------+|
43: * |\-|Sink ||
44: * | +---------+|
45: * +-------------+
46: * </pre>
47: *
48: * <p>Note that the <code>Multicaster</code> is very similar to the {@link
49: * Alternator Alternator}: where the multicaster sends a received message to
50: * all connected sinks, the Alternator sends it to only one sink.</p>
51: *
52: * <p>Also note that the <code>Multicaster</code> is also similar to the {@link
53: * Screener screener}: where the multicaster sends a received message to all
54: * connected sinks, the screener does so based on a user-provided
55: * configuration.</p>
56: *
57: * @author <a href="lsimons at jicarilla dot org">Leo Simons</a>
58: * @version $Id: Multicaster.java,v 1.1 2004/03/22 21:20:13 lsimons Exp $
59: */
60: public interface Multicaster extends Sink {
61: /**
62: * Add a sink which will be a recipient of all the messages this
63: * Multicaster receives.
64: *
65: * @param sink the sink that will receive messages
66: */
67: void addSink(Sink sink);
68: }
|