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.core5.reactor;
29
30 import org.apache.hc.core5.concurrent.FutureCallback;
31 import org.apache.hc.core5.net.NamedEndpoint;
32 import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer;
33
34 /**
35 * TLS capable, protocol upgradable {@link IOSession}.
36 *
37 * @since 5.0
38 */
39 public interface ProtocolIOSession extends IOSession, TransportSecurityLayer {
40
41 /**
42 * Switches this I/O session to the application protocol with the given ID.
43 * @param protocolId the application protocol ID
44 * @param callback the result callback
45 * @throws UnsupportedOperationException if application protocol switch
46 * is not supported.
47 */
48 default void switchProtocol(String protocolId, FutureCallback<ProtocolIOSession> callback) throws UnsupportedOperationException {
49 throw new UnsupportedOperationException("Protocol switch not supported");
50 }
51
52 /**
53 * Registers protocol upgrade handler with the given application protocol ID.
54 *
55 * @since 5.2
56 * @param protocolId the application protocol ID
57 * @param upgradeHandler the upgrade handler.
58 *
59 * @since 5.2
60 */
61 default void registerProtocol(String protocolId, ProtocolUpgradeHandler upgradeHandler) {
62 }
63
64 NamedEndpoint getInitialEndpoint();
65
66 }