socketfactory.java

jxta_src_2.41b jxta 2.41b 最新版源码 from www.jxta.org

/*
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *
 * $Id: SocketFactory.java,v 1.1 2004/05/14 01:12:20 msample Exp $
 */

package net.jxta.impl.endpoint;

import java.io.IOException;
import java.net.InetAddress;
import java.net.Socket;

/**
 * Provides pluggable socket creation for JXTA TCP connection (not
 * those for HTTP since those are from URLConnection).
 *
 * <p>The motivation for this class was to provide the ability to
 * tunnel JXTA TCP through a web proxy but it could be used for other
 * things as well. Call IPUtils.setSocketFactory() to configure JXTA
 * to use a particular socket factory</p>
 *
 * @author <a href="mailto:[e-mail]">Mike Sample</a>
 */
public interface SocketFactory {

    /**
     * creates and returns a connected Socket.
     *
     * @param inetAddress the destination IP address used to create an
     * InetSocketAddress that will be used with the connect() call on
     * the created socket.
     *
     * @param port the destination TCP port used to create an
     * InetSocketAddress that will be used with the connect() call on
     * the created socket.
     *
     * @param usingInterface the src (local) IP address used to create
     * an InetSocketAddress to which the created socket will be bound
     * via bind().
     *
     * @param localPort the src (local) TCP port used to create an
     * InetSocketAddress to which the created socket will be bound via
     * bind().
     *
     * @param timeout the time in milliseconds to be used with the
     * socket.connect() call. A value of zero means infinite timeout.
     *
     */
    public Socket createConnection(InetAddress inetAddress, int port,
                                   InetAddress usingInterface, int localPort,
                                   int timeout) throws IOException;

}