org.apache.hc.client5.http.io

## Interface HttpClientConnectionOperator

- All Known Implementing Classes:
    DefaultHttpClientConnectionOperator

      @Contract(threading=STATELESS)
       @Internal
      public interface HttpClientConnectionOperator

  Connection operator that performs connection connect and upgrade operations.
  Since:
    4.4

- - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `default void` | `connect(ManagedHttpClientConnection conn, org.apache.hc.core5.http.HttpHost host, InetSocketAddress localAddress, org.apache.hc.core5.util.Timeout connectTimeout, org.apache.hc.core5.http.io.SocketConfig socketConfig, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context)` Connect the given managed connection to the remote endpoint.
    `void` | `connect(ManagedHttpClientConnection conn, org.apache.hc.core5.http.HttpHost host, InetSocketAddress localAddress, org.apache.hc.core5.util.TimeValue connectTimeout, org.apache.hc.core5.http.io.SocketConfig socketConfig, org.apache.hc.core5.http.protocol.HttpContext context)` Connect the given managed connection to the remote endpoint.
    `void` | `upgrade(ManagedHttpClientConnection conn, org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.protocol.HttpContext context)` Upgrades transport security of the given managed connection by using the TLS security protocol.
    `default void` | `upgrade(ManagedHttpClientConnection conn, org.apache.hc.core5.http.HttpHost host, Object attachment, org.apache.hc.core5.http.protocol.HttpContext context)` Upgrades transport security of the given managed connection by using the TLS security protocol.

- - ### Method Detail

    - #### connect

          void connect(ManagedHttpClientConnection conn,
                       org.apache.hc.core5.http.HttpHost host,
                       InetSocketAddress localAddress,
                       org.apache.hc.core5.util.TimeValue connectTimeout,
                       org.apache.hc.core5.http.io.SocketConfig socketConfig,
                       org.apache.hc.core5.http.protocol.HttpContext context)
                throws IOException

      Connect the given managed connection to the remote endpoint.
      Parameters:
        `conn` - the managed connection.
        `host` - the address of the opposite endpoint.
        `localAddress` - the address of the local endpoint.
        `connectTimeout` - the timeout of the connect operation.
        `socketConfig` - the socket configuration.
        `context` - the execution context.
      Throws:
        `IOException`

    - #### connect

          default void connect(ManagedHttpClientConnection conn,
                               org.apache.hc.core5.http.HttpHost host,
                               InetSocketAddress localAddress,
                               org.apache.hc.core5.util.Timeout connectTimeout,
                               org.apache.hc.core5.http.io.SocketConfig socketConfig,
                               Object attachment,
                               org.apache.hc.core5.http.protocol.HttpContext context)
                        throws IOException

      Connect the given managed connection to the remote endpoint.
      Parameters:
        `conn` - the managed connection.
        `host` - the address of the opposite endpoint.
        `localAddress` - the address of the local endpoint.
        `connectTimeout` - the timeout of the connect operation.
        `socketConfig` - the socket configuration.
        `attachment` - connect request attachment.
        `context` - the execution context.
      Throws:
        `IOException`
      Since:
        5.2

    - #### upgrade

          void upgrade(ManagedHttpClientConnection conn,
                       org.apache.hc.core5.http.HttpHost host,
                       org.apache.hc.core5.http.protocol.HttpContext context)
                throws IOException

      Upgrades transport security of the given managed connection by using the TLS security protocol.
      Parameters:
        `conn` - the managed connection.
        `host` - the address of the opposite endpoint with TLS security.
        `context` - the execution context.
      Throws:
        `IOException`

    - #### upgrade

          default void upgrade(ManagedHttpClientConnection conn,
                               org.apache.hc.core5.http.HttpHost host,
                               Object attachment,
                               org.apache.hc.core5.http.protocol.HttpContext context)
                        throws IOException

      Upgrades transport security of the given managed connection by using the TLS security protocol.
      Parameters:
        `conn` - the managed connection.
        `host` - the address of the opposite endpoint with TLS security.
        `attachment` - connect request attachment.
        `context` - the execution context.
      Throws:
        `IOException`
      Since:
        5.2

Copyright © 1999–2021 The Apache Software Foundation. All rights reserved.