KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > channel > IPSocketManager


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s):
23  */

24
25 package org.objectweb.dream.channel;
26
27 import java.io.IOException JavaDoc;
28 import java.net.InetAddress JavaDoc;
29
30 /**
31  * Interface used by ChannelOut to retreive a socket to send a message to an
32  * IPChannelIn identified by its {@link InetAddress }and its port.
33  */

34 public interface IPSocketManager
35 {
36   /** The default name of interface of this type. */
37   String JavaDoc ITF_NAME = "ip-socket-manager";
38
39   /**
40    * Returns a socket that can be used to send message to the ChannelIn
41    * identified by the given IP address and port.
42    *
43    * @param address the address of the ChannelIn.
44    * @param port the port of the ChannelIn.
45    * @return a connection to the ChannelIn.
46    * @throws IOException if the socket can't be opened.
47    * @throws InterruptedException if the component is interrupted while waiting
48    * for a socket to be released.
49    */

50   SocketState getSocket(InetAddress JavaDoc address, int port) throws IOException JavaDoc,
51       InterruptedException JavaDoc;
52
53   /**
54    * Releases the given {@link SocketStateImpl }.
55    *
56    * @param socketState the socket state to release.
57    * @param error <code>true</code> if an exception has been catched while
58    * sending the message, <code>false</code> otherwise.
59    */

60   void releaseSocket(SocketState socketState, boolean error);
61
62 }
Popular Tags