1 //******************************************************************************
2 //
3 // File: ConnectListener.java
4 // Package: edu.rit.mp
5 // Unit: Interface edu.rit.mp.ConnectListener
6 //
7 // This Java source file is copyright (C) 2007 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.mp;
41
42 import java.io.IOException;
43
44 /**
45 * Interface ConnectListener specifies the interface for an object that is
46 * notified whenever a {@linkplain Channel} is connected in a {@linkplain
47 * ChannelGroup}.
48 *
49 * @author Alan Kaminsky
50 * @version 20-Dec-2007
51 */
52 public interface ConnectListener {
53
54 // Exported operations.
55 /**
56 * Report that a channel was connected in the given channel group, initiated
57 * by the near end. The channel group calls the <code>nearEndConnected()</code>
58 * method of a registered connect listener when the channel group's
59 * <code>connect()</code> method is called by code in the same process.
60 *
61 * @param theChannelGroup Channel group that is calling this method.
62 * @param theChannel Newly created channel.
63 * @exception IOException Thrown if an I/O error occurred.
64 * @throws java.io.IOException if any.
65 */
66 public void nearEndConnected(ChannelGroup theChannelGroup,
67 Channel theChannel)
68 throws IOException;
69
70 /**
71 * Report that a channel was connected in the given channel group, initiated
72 * by the far end. The channel group calls the <code>farEndConnected()</code>
73 * method of a registered connect listener when an incoming connection
74 * request is received from another process.
75 *
76 * @param theChannelGroup Channel group that is calling this method.
77 * @param theChannel Newly created channel.
78 * @exception IOException Thrown if an I/O error occurred.
79 * @throws java.io.IOException if any.
80 */
81 public void farEndConnected(ChannelGroup theChannelGroup,
82 Channel theChannel)
83 throws IOException;
84
85 }