public interface HttpClient extends Measured
It allows you to make requests to HTTP servers, and a single client can make requests to any server.
It also allows you to open WebSockets to servers.
The client can also pool HTTP connections.
For pooling to occur, keep-alive must be true on the HttpClientOptions
(default is true).
In this case connections will be pooled and re-used if there are pending HTTP requests waiting to get a connection,
otherwise they will be closed.
This gives the benefits of keep alive when the client is loaded but means we don't keep connections hanging around unnecessarily when there would be no benefits anyway.
The client also supports pipe-lining of requests. Pipe-lining means another request is sent on the same connection before the response from the preceding one has returned. Pipe-lining is not appropriate for all requests.
To enable pipe-lining, it must be enabled on the HttpClientOptions
(default is false).
When pipe-lining is enabled the connection will be automatically closed when all in-flight responses have returned and there are no outstanding pending requests to write.
The client is designed to be reused between requests.
Modifier and Type | Method and Description |
---|---|
Future<Void> |
close()
Like
close(Handler) but returns a Future of the asynchronous result |
void |
close(Handler<AsyncResult<Void>> handler)
Close the client.
|
HttpClient |
connectionHandler(Handler<HttpConnection> handler)
Set a connection handler for the client.
|
java.util.function.Function<HttpClientResponse,Future<RequestOptions>> |
redirectHandler() |
HttpClient |
redirectHandler(java.util.function.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
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
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
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
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
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
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
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
webSocket(WebSocketConnectOptions, Handler) but returns a Future of the asynchronous result |
void |
webSocket(WebSocketConnectOptions options,
Handler<AsyncResult<WebSocket>> handler)
Connect a WebSocket with the specified options.
|
Future<WebSocket> |
webSocketAbs(String url,
MultiMap headers,
WebsocketVersion version,
List<String> subProtocols)
Like
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.
|
isMetricsEnabled
void request(RequestOptions options, Handler<AsyncResult<HttpClientRequest>> handler)
handler
is called when the request is ready to be sent.options
- the request optionshandler
- the handler called when the request is ready to be sentFuture<HttpClientRequest> request(RequestOptions options)
request(RequestOptions, Handler)
but returns a Future
of the asynchronous resultvoid request(HttpMethod method, int port, String host, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)
host
and port
. The handler
is called when the request is ready to be sent.method
- the HTTP methodport
- the porthost
- the hostrequestURI
- the relative URIhandler
- the handler called when the request is ready to be sentFuture<HttpClientRequest> request(HttpMethod method, int port, String host, String requestURI)
request(HttpMethod, int, String, String, Handler)
but returns a Future
of the asynchronous resultvoid request(HttpMethod method, String host, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)
host
and default port. The handler
is called when the request is ready to be sent.method
- the HTTP methodhost
- the hostrequestURI
- the relative URIhandler
- the handler called when the request is ready to be sentFuture<HttpClientRequest> request(HttpMethod method, String host, String requestURI)
request(HttpMethod, String, String, Handler)
but returns a Future
of the asynchronous resultvoid request(HttpMethod method, String requestURI, Handler<AsyncResult<HttpClientRequest>> handler)
handler
is called when the request is ready to be sent.method
- the HTTP methodrequestURI
- the relative URIhandler
- the handler called when the request is ready to be sentFuture<HttpClientRequest> request(HttpMethod method, String requestURI)
request(HttpMethod, String, Handler)
but returns a Future
of the asynchronous resultvoid webSocket(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
port
- the porthost
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connectedFuture<WebSocket> webSocket(int port, String host, String requestURI)
webSocket(int, String, String, Handler)
but returns a Future
of the asynchronous resultvoid webSocket(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler)
host
- the hostrequestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connectedFuture<WebSocket> webSocket(String host, String requestURI)
webSocket(String, String, Handler)
but returns a Future
of the asynchronous resultvoid webSocket(String requestURI, Handler<AsyncResult<WebSocket>> handler)
requestURI
- the relative URIhandler
- handler that will be called with the WebSocket when connectedFuture<WebSocket> webSocket(String requestURI)
webSocket(String, Handler)
but returns a Future
of the asynchronous resultvoid webSocket(WebSocketConnectOptions options, Handler<AsyncResult<WebSocket>> handler)
options
- the request optionsFuture<WebSocket> webSocket(WebSocketConnectOptions options)
webSocket(WebSocketConnectOptions, Handler)
but returns a Future
of the asynchronous resultvoid webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols, Handler<AsyncResult<WebSocket>> handler)
url
- the absolute urlheaders
- the headersversion
- the WebSocket versionsubProtocols
- the subprotocols to usehandler
- handler that will be called if WebSocket connection failsFuture<WebSocket> webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols)
webSocketAbs(String, MultiMap, WebsocketVersion, List, Handler)
but returns a Future
of the asynchronous resultHttpClient connectionHandler(Handler<HttpConnection> handler)
HttpClient redirectHandler(java.util.function.Function<HttpClientResponse,Future<RequestOptions>> handler)
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
.
Future<HttpClientRequest>
is returned, the client will send this new request
The handler must return a Future<HttpClientRequest>
unsent so the client can further configure it and send it.
handler
- the new redirect handlerjava.util.function.Function<HttpClientResponse,Future<RequestOptions>> redirectHandler()
void close(Handler<AsyncResult<Void>> handler)
Future<Void> close()
close(Handler)
but returns a Future
of the asynchronous resultCopyright © 2023 Eclipse. All rights reserved.