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 org.apache.hc.core5.annotation.Internal;
31 import org.apache.hc.core5.concurrent.FutureCallback;
32 import org.apache.hc.core5.http.HttpConnection;
33 import org.apache.hc.core5.reactor.Command;
34 import org.apache.hc.core5.reactor.ProtocolIOSession;
35 import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer;
36
37 /**
38 * Represents a managed asynchronous connection whose state and life cycle
39 * is managed by a connection manager.
40 *
41 * @since 5.0
42 */
43 @Internal
44 public interface ManagedAsyncClientConnection extends HttpConnection, TransportSecurityLayer {
45
46 /**
47 * Submits the given command for execution.
48 *
49 * @param command the command to be executed.
50 * @param priority the command priority.
51 */
52 void submitCommand(Command command, Command.Priority priority);
53
54 /**
55 * Puts the connection into idle mode.
56 */
57 void passivate();
58
59 /**
60 * Restores the connection from idle mode.
61 */
62 void activate();
63
64 /**
65 * Switches this I/O session to the application protocol with the given ID.
66 * @param protocolId the application protocol ID
67 * @param callback the result callback
68 * @throws UnsupportedOperationException if application protocol switch
69 * is not supported.
70 *
71 * @since 5.2
72 */
73 default void switchProtocol(String protocolId, FutureCallback<ProtocolIOSession> callback) throws UnsupportedOperationException {
74 throw new UnsupportedOperationException("Protocol switch not supported");
75 }
76
77 }