org.glassfish.grizzly.SocketConnectorHandler Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2008-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.grizzly;
import java.io.IOException;
import java.net.SocketAddress;
import java.util.concurrent.Future;
/**
* Socket based client side connector.
* SocketConnectorHandler is responsible for creating and initializing
* {@link Connection}, and optionally connect is to a specific local/remote
* address.
*
* @author Alexey Stashok
*/
public interface SocketConnectorHandler extends ConnectorHandler {
int DEFAULT_CONNECTION_TIMEOUT = 30000;
/**
* Creates, initializes and connects socket to the specific remote host
* and port and returns {@link Connection}, representing socket.
*
* @param host remote host to connect to.
* @param port remote port to connect to.
* @return {@link Future} of connect operation, which could be used to get
* resulting {@link Connection}.
*
* @throws java.io.IOException
*/
Future connect(String host, int port) throws IOException;
}