Package: SocketConnectorHandler

SocketConnectorHandler

Coverage

1: /*
2: * Copyright (c) 2008, 2020 Oracle and/or its affiliates. All rights reserved.
3: *
4: * This program and the accompanying materials are made available under the
5: * terms of the Eclipse Public License v. 2.0, which is available at
6: * http://www.eclipse.org/legal/epl-2.0.
7: *
8: * This Source Code may also be made available under the following Secondary
9: * Licenses when the conditions for such availability set forth in the
10: * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
11: * version 2 with the GNU Classpath Exception, which is available at
12: * https://www.gnu.org/software/classpath/license.html.
13: *
14: * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15: */
16:
17: package org.glassfish.grizzly;
18:
19: import java.io.IOException;
20: import java.net.SocketAddress;
21: import java.util.concurrent.Future;
22:
23: /**
24: * Socket based client side connector. <tt>SocketConnectorHandler</tt> is responsible for creating and initializing
25: * {@link Connection}, and optionally connect is to a specific local/remote address.
26: *
27: * @author Alexey Stashok
28: */
29: public interface SocketConnectorHandler extends ConnectorHandler<SocketAddress> {
30:
31: int DEFAULT_CONNECTION_TIMEOUT = 30000;
32:
33: /**
34: * Creates, initializes and connects socket to the specific remote host and port and returns {@link Connection},
35: * representing socket.
36: *
37: * @param host remote host to connect to.
38: * @param port remote port to connect to.
39: * @return {@link Future} of connect operation, which could be used to get resulting {@link Connection}.
40: *
41: * @throws java.io.IOException not actually thrown
42: */
43: Future<Connection> connect(String host, int port) throws IOException;
44: }