View Javadoc
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.http.HttpConnection;
32  import org.apache.hc.core5.reactor.Command;
33  import org.apache.hc.core5.reactor.ssl.TransportSecurityLayer;
34  
35  /**
36   * Represents a managed asynchronous connection whose state and life cycle
37   * is managed by a connection manager.
38   *
39   * @since 5.0
40   */
41  @Internal
42  public interface ManagedAsyncClientConnection extends HttpConnection, TransportSecurityLayer {
43  
44      /**
45       * Submits the given command for execution.
46       *
47       * @param command the command to be executed.
48       * @param priority the command priority.
49       */
50      void submitCommand(Command command, Command.Priority priority);
51  
52      /**
53       * Puts the connection into idle mode.
54       */
55      void passivate();
56  
57      /**
58       * Restores the connection from idle mode.
59       */
60      void activate();
61  
62  }