org.apache.hc.client5.http.nio.ManagedAsyncClientConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of httpclient5 Show documentation
Apache HttpComponents Client
The newest version!
/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */

package org.apache.hc.client5.http.nio;

import org.apache.hc.core5.annotation.Internal;
import org.apache.hc.core5.concurrent.FutureCallback;
import org.apache.hc.core5.http.HttpConnection;
import org.apache.hc.core5.reactor.Command;
import org.apache.hc.core5.reactor.ProtocolIOSession;
import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer;

/**
 * Represents a managed asynchronous connection whose state and life cycle
 * is managed by a connection manager.
 *
 * @since 5.0
 */
@Internal
public interface ManagedAsyncClientConnection extends HttpConnection, TransportSecurityLayer {

    /**
     * Submits the given command for execution.
     *
     * @param command the command to be executed.
     * @param priority the command priority.
     */
    void submitCommand(Command command, Command.Priority priority);

    /**
     * Puts the connection into idle mode.
     */
    void passivate();

    /**
     * Restores the connection from idle mode.
     */
    void activate();

    /**
     * Switches this I/O session to the application protocol with the given ID.
     * @param protocolId the application protocol ID
     * @param callback the result callback
     * @throws UnsupportedOperationException if application protocol switch
     * is not supported.
     *
     * @since 5.2
     */
    default void switchProtocol(String protocolId, FutureCallback callback) throws UnsupportedOperationException {
        throw new UnsupportedOperationException("Protocol switch not supported");
    }

}