SocketManager


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  ;
28  
29  import org.objectweb.dream.message.Message;
30  
31  /**
32   * Interface used by ChannelOut to retreive a socket to send a message to a
33   * ChannelIn.
34   */
35  public interface SocketManager
36  {
37    /** The default name of interface of this type. */
38    String   ITF_NAME = "socket-manager";
39  
40    /**
41     * Returns a socket that can be used to send message to a ChannelIn
42     * 
43     * @param message a message that is going to be sent to a ChannelIn
44     * @return a connection to the ChannelIn.
45     * @throws IOException if the socket can't be opened.
46     * @throws InterruptedException if the component is interrupted while waiting.
47     */
48    SocketState getSocket(Message message) throws IOException  ,
49        InterruptedException  ;
50  
51    /**
52     * Releases the given {@link SocketState }.
53     * 
54     * @param socketState the socket state to release.
55     * @param error <code>true</code> if an exception has been catched while
56     *          sending the message, <code>false</code> otherwise.
57     */
58    void releaseSocket(SocketState socketState, boolean error);
59  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags