1 /* 2 * ==================================================================== 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * ==================================================================== 20 * 21 * This software consists of voluntary contributions made by many 22 * individuals on behalf of the Apache Software Foundation. For more 23 * information on the Apache Software Foundation, please see 24 * <http://www.apache.org/>. 25 * 26 */ 27 28 package org.apache.hc.client5.http.nio; 29 30 import java.net.SocketAddress; 31 import java.util.concurrent.Future; 32 33 import org.apache.hc.core5.annotation.Contract; 34 import org.apache.hc.core5.annotation.Internal; 35 import org.apache.hc.core5.annotation.ThreadingBehavior; 36 import org.apache.hc.core5.concurrent.FutureCallback; 37 import org.apache.hc.core5.http.HttpHost; 38 import org.apache.hc.core5.reactor.ConnectionInitiator; 39 import org.apache.hc.core5.util.Timeout; 40 41 /** 42 * Connection operator that performs connection connect and upgrade operations. 43 * 44 * @since 5.0 45 */ 46 @Contract(threading = ThreadingBehavior.STATELESS) 47 @Internal 48 public interface AsyncClientConnectionOperator { 49 50 /** 51 * Initiates operation to create a connection to the remote endpoint using 52 * the provided {@link ConnectionInitiator}. 53 * 54 * @param connectionInitiator the connection initiator. 55 * @param host the address of the opposite endpoint. 56 * @param localAddress the address of the local endpoint. 57 * @param connectTimeout the timeout of the connect operation. 58 * @param attachment the attachment, which can be any object representing custom parameter 59 * of the operation. 60 * @param callback the future result callback. 61 */ 62 Future<ManagedAsyncClientConnection> connect( 63 ConnectionInitiator connectionInitiator, 64 HttpHost host, 65 SocketAddress localAddress, 66 Timeout connectTimeout, 67 Object attachment, 68 FutureCallback<ManagedAsyncClientConnection> callback); 69 70 71 /** 72 * Upgrades transport security of the given managed connection 73 * by using the TLS security protocol. 74 * 75 * @param conn the managed connection. 76 * @param host the address of the opposite endpoint with TLS security. 77 * @param attachment the attachment, which can be any object representing custom parameter 78 * of the operation. 79 */ 80 void upgrade(ManagedAsyncClientConnection conn, HttpHost host, Object attachment); 81 82 }