HttpClientImpl (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.core.http.impl.HttpClientImpl

All Implemented Interfaces:

Closeable, HttpClient, Measured, MetricsProvider
```
public class HttpClientImpl
extends Object
implements HttpClient, MetricsProvider, Closeable
```
This class is thread-safe.

Author:

Tim Fox

Constructor Summary

Constructors
Constructor and Description

HttpClientImpl(VertxInternal vertx, HttpClientOptions options, CloseFuture closeFuture)

Constructors
Constructor and Description
`HttpClientImpl(VertxInternal vertx, HttpClientOptions options, CloseFuture closeFuture)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Future<Void>`	`close()` Like `HttpClient.close(Handler)` but returns a `Future` of the asynchronous result
`void`	`close(Handler<AsyncResult<Void>> handler)` Close the client.
`void`	`close(Promise<Void> completion)` Close this resource, the `completion` promise must be notified when the operation has completed.
`Future<HttpClientConnection>`	`connect(SocketAddress server)` Connect to a server.
`Future<HttpClientConnection>`	`connect(SocketAddress server, SocketAddress peer)` Connect to a server.
`HttpClient`	`connectionHandler(Handler<HttpConnection> handler)` Set a connection handler for the client.
`protected void`	`finalize()`
`Metrics`	`getMetrics()` Returns the metrics implementation.
`HttpClientOptions`	`getOptions()`
`VertxInternal`	`getVertx()`
`boolean`	`isMetricsEnabled()` Whether the metrics are enabled for this measured object
`Function<HttpClientResponse,Future<RequestOptions>>`	`redirectHandler()`
`HttpClient`	`redirectHandler(Function<HttpClientResponse,Future<RequestOptions>> handler)` Set a redirect handler for the http client.
`Future<HttpClientRequest>`	`request(HttpMethod method, int port, String host, String requestURI)` Like `HttpClient.request(HttpMethod, int, String, String, Handler)` but returns a `Future` of the asynchronous result
`void`	`request(HttpMethod method, int port, String host, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)` Create an HTTP request to send to the server at the `host` and `port`.
`Future<HttpClientRequest>`	`request(HttpMethod method, String requestURI)` Like `HttpClient.request(HttpMethod, String, Handler)` but returns a `Future` of the asynchronous result
`void`	`request(HttpMethod method, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)` Create an HTTP request to send to the server at the default host and port.
`Future<HttpClientRequest>`	`request(HttpMethod method, String host, String requestURI)` Like `HttpClient.request(HttpMethod, String, String, Handler)` but returns a `Future` of the asynchronous result
`void`	`request(HttpMethod method, String host, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)` Create an HTTP request to send to the server at the `host` and default port.
`Future<HttpClientRequest>`	`request(RequestOptions options)` Like `HttpClient.request(RequestOptions, Handler)` but returns a `Future` of the asynchronous result
`void`	`request(RequestOptions options, Handler<AsyncResult<HttpClientRequest>> handler)` Create an HTTP request to send to the server.
`Future<WebSocket>`	`webSocket(int port, String host, String requestURI)` Like `HttpClient.webSocket(int, String, String, Handler)` but returns a `Future` of the asynchronous result
`void`	`webSocket(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket to the specified port, host and relative request URI
`Future<WebSocket>`	`webSocket(String requestURI)` Like `HttpClient.webSocket(String, Handler)` but returns a `Future` of the asynchronous result
`void`	`webSocket(String requestURI, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket at the relative request URI using the default host and port
`Future<WebSocket>`	`webSocket(String host, String requestURI)` Like `HttpClient.webSocket(String, String, Handler)` but returns a `Future` of the asynchronous result
`void`	`webSocket(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket to the host and relative request URI and default port
`Future<WebSocket>`	`webSocket(WebSocketConnectOptions options)` Like `HttpClient.webSocket(WebSocketConnectOptions, Handler)` but returns a `Future` of the asynchronous result
`void`	`webSocket(WebSocketConnectOptions connectOptions, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified options.
`Future<WebSocket>`	`webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols)` Like `HttpClient.webSocketAbs(String, MultiMap, WebsocketVersion, List, Handler)` but returns a `Future` of the asynchronous result
`void`	`webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols, Handler<AsyncResult<WebSocket>> handler)` Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified WebSocket sub protocols.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpClientImpl
```
public HttpClientImpl(VertxInternal vertx,
                      HttpClientOptions options,
                      CloseFuture closeFuture)
```
- Method Detail
  - connect
```
public Future<HttpClientConnection> connect(SocketAddress server)
```
    Connect to a server.
  - connect
```
public Future<HttpClientConnection> connect(SocketAddress server,
                                            SocketAddress peer)
```
    Connect to a server.
  - webSocket
```
public void webSocket(WebSocketConnectOptions connectOptions,
                      Handler<AsyncResult<WebSocket>> handler)
```
    Description copied from interface: HttpClient
    
    Connect a WebSocket with the specified options.
    
    Specified by:
    
    webSocket in interface HttpClient
    
    Parameters:
    
    connectOptions - the request options
  - webSocket
```
public Future<WebSocket> webSocket(int port,
                                   String host,
                                   String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.webSocket(int, String, String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    webSocket in interface HttpClient
  - webSocket
```
public Future<WebSocket> webSocket(String host,
                                   String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.webSocket(String, String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    webSocket in interface HttpClient
  - webSocket
```
public Future<WebSocket> webSocket(String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.webSocket(String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    webSocket in interface HttpClient
  - webSocket
```
public Future<WebSocket> webSocket(WebSocketConnectOptions options)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.webSocket(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    webSocket in interface HttpClient
  - webSocketAbs
```
public Future<WebSocket> webSocketAbs(String url,
                                      MultiMap headers,
                                      WebsocketVersion version,
                                      List<String> subProtocols)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.webSocketAbs(String, MultiMap, WebsocketVersion, List, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    webSocketAbs in interface HttpClient
  - webSocket
```
public void webSocket(int port,
                      String host,
                      String requestURI,
                      Handler<AsyncResult<WebSocket>> handler)
```
    Description copied from interface: HttpClient
    
    Connect a WebSocket to the specified port, host and relative request URI
    
    Specified by:
    
    webSocket in interface HttpClient
    
    Parameters:
    
    port - the port
    
    host - the host
    
    requestURI - the relative URI
    
    handler - handler that will be called with the WebSocket when connected
  - webSocket
```
public void webSocket(String host,
                      String requestURI,
                      Handler<AsyncResult<WebSocket>> handler)
```
    Description copied from interface: HttpClient
    
    Connect a WebSocket to the host and relative request URI and default port
    
    Specified by:
    
    webSocket in interface HttpClient
    
    Parameters:
    
    host - the host
    
    requestURI - the relative URI
    
    handler - handler that will be called with the WebSocket when connected
  - webSocket
```
public void webSocket(String requestURI,
                      Handler<AsyncResult<WebSocket>> handler)
```
    Description copied from interface: HttpClient
    
    Connect a WebSocket at the relative request URI using the default host and port
    
    Specified by:
    
    webSocket in interface HttpClient
    
    Parameters:
    
    requestURI - the relative URI
    
    handler - handler that will be called with the WebSocket when connected
  - webSocketAbs
```
public void webSocketAbs(String url,
                         MultiMap headers,
                         WebsocketVersion version,
                         List<String> subProtocols,
                         Handler<AsyncResult<WebSocket>> handler)
```
    Description copied from interface: HttpClient
    
    Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified WebSocket sub protocols.
    
    Specified by:
    
    webSocketAbs in interface HttpClient
    
    Parameters:
    
    url - the absolute url
    
    headers - the headers
    
    version - the WebSocket version
    
    subProtocols - the subprotocols to use
    
    handler - handler that will be called if WebSocket connection fails
  - request
```
public void request(RequestOptions options,
                    Handler<AsyncResult<HttpClientRequest>> handler)
```
    Description copied from interface: HttpClient
    
    Create an HTTP request to send to the server. The handler is called when the request is ready to be sent.
    
    Specified by:
    
    request in interface HttpClient
    
    Parameters:
    
    options - the request options
    
    handler - the handler called when the request is ready to be sent
  - request
```
public Future<HttpClientRequest> request(RequestOptions options)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.request(RequestOptions, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    request in interface HttpClient
  - request
```
public void request(HttpMethod method,
                    int port,
                    String host,
                    String requestURI,
                    Handler<AsyncResult<HttpClientRequest>> handler)
```
    Description copied from interface: HttpClient
    
    Create an HTTP request to send to the server at the host and port. The handler is called when the request is ready to be sent.
    
    Specified by:
    
    request in interface HttpClient
    
    Parameters:
    
    method - the HTTP method
    
    port - the port
    
    host - the host
    
    requestURI - the relative URI
    
    handler - the handler called when the request is ready to be sent
  - request
```
public Future<HttpClientRequest> request(HttpMethod method,
                                         int port,
                                         String host,
                                         String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.request(HttpMethod, int, String, String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    request in interface HttpClient
  - request
```
public void request(HttpMethod method,
                    String host,
                    String requestURI,
                    Handler<AsyncResult<HttpClientRequest>> handler)
```
    Description copied from interface: HttpClient
    
    Create an HTTP request to send to the server at the host and default port. The handler is called when the request is ready to be sent.
    
    Specified by:
    
    request in interface HttpClient
    
    Parameters:
    
    method - the HTTP method
    
    host - the host
    
    requestURI - the relative URI
    
    handler - the handler called when the request is ready to be sent
  - request
```
public Future<HttpClientRequest> request(HttpMethod method,
                                         String host,
                                         String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.request(HttpMethod, String, String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    request in interface HttpClient
  - request
```
public void request(HttpMethod method,
                    String requestURI,
                    Handler<AsyncResult<HttpClientRequest>> handler)
```
    Description copied from interface: HttpClient
    
    Create an HTTP request to send to the server at the default host and port. The handler is called when the request is ready to be sent.
    
    Specified by:
    
    request in interface HttpClient
    
    Parameters:
    
    method - the HTTP method
    
    requestURI - the relative URI
    
    handler - the handler called when the request is ready to be sent
  - request
```
public Future<HttpClientRequest> request(HttpMethod method,
                                         String requestURI)
```
    Description copied from interface: HttpClient
    
    Like HttpClient.request(HttpMethod, String, Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    request in interface HttpClient
  - close
```
public void close(Promise<Void> completion)
```
    Description copied from interface: Closeable
    
    Close this resource, the completion promise must be notified when the operation has completed.
    
    Specified by:
    
    close in interface Closeable
    
    Parameters:
    
    completion - the promise to signal when close has completed
  - close
```
public void close(Handler<AsyncResult<Void>> handler)
```
    Description copied from interface: HttpClient
    
    Close the client. Closing will close down any pooled connections. Clients should always be closed after use.
    
    Specified by:
    
    close in interface HttpClient
  - close
```
public Future<Void> close()
```
    Description copied from interface: HttpClient
    
    Like HttpClient.close(Handler) but returns a Future of the asynchronous result
    
    Specified by:
    
    close in interface HttpClient
  - isMetricsEnabled
```
public boolean isMetricsEnabled()
```
    Description copied from interface: Measured
    
    Whether the metrics are enabled for this measured object
    
    Specified by:
    
    isMetricsEnabled in interface Measured
    
    Returns:
    
    true if metrics are enabled
  - getMetrics
```
public Metrics getMetrics()
```
    Description copied from interface: MetricsProvider
    
    Returns the metrics implementation.
    
    Specified by:
    
    getMetrics in interface MetricsProvider
    
    Returns:
    
    the metrics
  - connectionHandler
```
public HttpClient connectionHandler(Handler<HttpConnection> handler)
```
    Description copied from interface: HttpClient
    
    Set a connection handler for the client. This handler is called when a new connection is established.
    
    Specified by:
    
    connectionHandler in interface HttpClient
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - redirectHandler
```
public HttpClient redirectHandler(Function<HttpClientResponse,Future<RequestOptions>> handler)
```
    Description copied from interface: HttpClient
    Set a redirect handler for the http client.
    The redirect handler is called when a 3xx response is received and the request is configured to follow redirects with HttpClientRequest.setFollowRedirects(boolean).
    The redirect handler is passed the HttpClientResponse, it can return an HttpClientRequest or null.
    - when null is returned, the original response is processed by the original request response handler
    - when a new Future<HttpClientRequest> is returned, the client will send this new request
    The new request will get a copy of the previous request headers unless headers are set. In this case, the client assumes that the redirect handler exclusively managers the headers of the new request.
    The handler must return a Future<HttpClientRequest> unsent so the client can further configure it and send it.
    Specified by:
    
    redirectHandler in interface HttpClient
    
    Parameters:
    
    handler - the new redirect handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - redirectHandler
```
public Function<HttpClientResponse,Future<RequestOptions>> redirectHandler()
```
    Specified by:
    
    redirectHandler in interface HttpClient
    
    Returns:
    
    the current redirect handler.
  - getOptions
```
public HttpClientOptions getOptions()
```
  - getVertx
```
public VertxInternal getVertx()
```
    Returns:
    
    the vertx, for use in package related classes only.
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable

Class HttpClientImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpClientImpl

Method Detail

connect

connect

webSocket

webSocket

webSocket

webSocket

webSocket

webSocketAbs

webSocket

webSocket

webSocket

webSocketAbs

request

request

request

request

request

request

request

request

close

close

close

isMetricsEnabled

getMetrics

connectionHandler

redirectHandler

redirectHandler

getOptions

getVertx

finalize