/*
 * Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.http;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.core.metrics.Measured;
import io.vertx.core.net.SocketAddress;
import io.vertx.core.streams.ReadStream;

import java.util.List;
import java.util.function.Function;

An asynchronous HTTP client.

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.

Author:Tim Fox
/** * An asynchronous HTTP client. * <p> * It allows you to make requests to HTTP servers, and a single client can make requests to any server. * <p> * It also allows you to open WebSockets to servers. * <p> * The client can also pool HTTP connections. * <p> * For pooling to occur, keep-alive must be true on the {@link io.vertx.core.http.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. * <p> * 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. * <p> * 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. * <p> * To enable pipe-lining, it must be enabled on the {@link io.vertx.core.http.HttpClientOptions} (default is false). * <p> * 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. * <p> * The client is designed to be reused between requests. * * @author <a href="http://tfox.org">Tim Fox</a> */
@VertxGen public interface HttpClient extends Measured {
Like request(HttpMethod, RequestOptions) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the options parameter.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #request(HttpMethod, RequestOptions)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code options} parameter. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest request(HttpMethod method, SocketAddress serverAddress, RequestOptions options);
Create an HTTP request to send to the server with the specified options.
Params:
  • method – the HTTP method
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP request to send to the server with the specified options. * * @param method the HTTP method * @param options the request options * @return an HTTP client request object */
HttpClientRequest request(HttpMethod method, RequestOptions options);
Create an HTTP request to send to the server at the specified host and port.
Params:
  • method – the HTTP method
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP request to send to the server at the specified host and port. * @param method the HTTP method * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest request(HttpMethod method, int port, String host, String requestURI);
Like request(HttpMethod, int, String, String) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the host and port parameters.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #request(HttpMethod, int, String, String)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code host} and {@code port} parameters. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest request(HttpMethod method, SocketAddress serverAddress, int port, String host, String requestURI);
Create an HTTP request to send to the server at the specified host and default port.
Params:
  • method – the HTTP method
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP request to send to the server at the specified host and default port. * @param method the HTTP method * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest request(HttpMethod method, String host, String requestURI);
Create an HTTP request to send to the server with the specified options, specifying a response handler to receive
Params:
  • method – the HTTP method
  • options – the request options
Returns: an HTTP client request object
Deprecated:this method will break in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>
/** * Create an HTTP request to send to the server with the specified options, specifying a response handler to receive * * @param method the HTTP method * @param options the request options * @return an HTTP client request object * @deprecated this method will break in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>} */
@Deprecated HttpClientRequest request(HttpMethod method, RequestOptions options, Handler<HttpClientResponse> responseHandler);
Like request(HttpMethod, RequestOptions, Handler<HttpClientResponse>) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the options parameter.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #request(HttpMethod, RequestOptions, Handler)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code options} parameter. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest request(HttpMethod method, SocketAddress serverAddress, RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • method – the HTTP method
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param method the HTTP method * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest request(HttpMethod method, int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Like request(HttpMethod, int, String, String, Handler<HttpClientResponse>) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the host and port parameters.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #request(HttpMethod, int, String, String, Handler)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code host} and {@code port} parameters. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest request(HttpMethod method, SocketAddress serverAddress, int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • method – the HTTP method
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param method the HTTP method * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest request(HttpMethod method, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP request to send to the server at the default host and port.
Params:
  • method – the HTTP method
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP request to send to the server at the default host and port. * @param method the HTTP method * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest request(HttpMethod method, String requestURI);
Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • method – the HTTP method
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive * the response * @param method the HTTP method * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest request(HttpMethod method, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP request to send to the server using an absolute URI
Params:
  • method – the HTTP method
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP request to send to the server using an absolute URI * @param method the HTTP method * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest requestAbs(HttpMethod method, String absoluteURI);
Like requestAbs(HttpMethod, String) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the absoluteURI parameter.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #requestAbs(HttpMethod, String)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code absoluteURI} parameter. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest requestAbs(HttpMethod method, SocketAddress serverAddress, String absoluteURI);
Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • method – the HTTP method
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param method the HTTP method * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest requestAbs(HttpMethod method, String absoluteURI, Handler<HttpClientResponse> responseHandler);
Like requestAbs(HttpMethod, String, Handler<HttpClientResponse>) using the serverAddress parameter to connect to the server instead of the absoluteURI parameter.

The request host header will still be created from the absoluteURI parameter.

Use SocketAddress.domainSocketAddress(String) to connect to a unix domain socket server.

/** * Like {@link #requestAbs(HttpMethod, String, Handler)} using the {@code serverAddress} parameter to connect to the * server instead of the {@code absoluteURI} parameter. * <p> * The request host header will still be created from the {@code absoluteURI} parameter. * <p> * Use {@link SocketAddress#domainSocketAddress(String)} to connect to a unix domain socket server. */
HttpClientRequest requestAbs(HttpMethod method, SocketAddress serverAddress, String absoluteURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP GET request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP GET request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest get(RequestOptions options);
Create an HTTP GET request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP GET request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest get(int port, String host, String requestURI);
Create an HTTP GET request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP GET request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest get(String host, String requestURI);
Create an HTTP GET request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP GET request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest get(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP GET request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP GET request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest get(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP GET request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP GET request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest get(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP GET request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP GET request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest get(String requestURI);
Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest get(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP GET request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP GET request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest getAbs(String absoluteURI);
Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest getAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP GET request to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP GET request to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient getNow(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient getNow(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP GET request to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP GET request to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient getNow(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP GET request to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP GET request to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient getNow(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP POST request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP POST request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest post(RequestOptions options);
Create an HTTP POST request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP POST request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest post(int port, String host, String requestURI);
Create an HTTP POST request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP POST request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest post(String host, String requestURI);
Create an HTTP POST request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP POST request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest post(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP POST request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP POST request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest post(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP POST request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP POST request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest post(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP POST request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP POST request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest post(String requestURI);
Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest post(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP POST request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP POST request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest postAbs(String absoluteURI);
Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest postAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP HEAD request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP HEAD request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest head(RequestOptions options);
Create an HTTP HEAD request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP HEAD request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest head(int port, String host, String requestURI);
Create an HTTP HEAD request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP HEAD request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest head(String host, String requestURI);
Create an HTTP HEAD request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP HEAD request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest head(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP HEAD request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP HEAD request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest head(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP HEAD request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP HEAD request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest head(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP HEAD request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP HEAD request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest head(String requestURI);
Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest head(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP HEAD request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP HEAD request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest headAbs(String absoluteURI);
Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest headAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP HEAD request to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP HEAD request to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient headNow(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient headNow(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP HEAD request to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP HEAD request to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient headNow(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP HEAD request to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP HEAD request to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient headNow(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP OPTIONS request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP OPTIONS request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest options(RequestOptions options);
Create an HTTP OPTIONS request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP OPTIONS request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest options(int port, String host, String requestURI);
Create an HTTP OPTIONS request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP OPTIONS request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest options(String host, String requestURI);
Create an HTTP OPTIONS request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP OPTIONS request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest options(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP OPTIONS request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP OPTIONS request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest options(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP OPTIONS request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP OPTIONS request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest options(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP OPTIONS request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP OPTIONS request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest options(String requestURI);
Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest options(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP OPTIONS request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP OPTIONS request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest optionsAbs(String absoluteURI);
Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest optionsAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP OPTIONS request to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP OPTIONS request to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient optionsNow(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient optionsNow(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP OPTIONS request to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP OPTIONS request to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient optionsNow(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Sends an HTTP OPTIONS request to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns:a reference to this, so the API can be used fluently
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Sends an HTTP OPTIONS request to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return a reference to this, so the API can be used fluently * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated @Fluent HttpClient optionsNow(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP PUT request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP PUT request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest put(RequestOptions options);
Create an HTTP PUT request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP PUT request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest put(int port, String host, String requestURI);
Create an HTTP PUT request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP PUT request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest put(String host, String requestURI);
Create an HTTP PUT request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP PUT request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest put(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP PUT request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP PUT request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest put(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP PUT request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP PUT request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest put(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP PUT request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP PUT request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest put(String requestURI);
Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest put(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP PUT request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP PUT request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest putAbs(String absoluteURI);
Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest putAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP DELETE request to send to the server with the specified options.
Params:
  • options – the request options
Returns: an HTTP client request object
/** * Create an HTTP DELETE request to send to the server with the specified options. * @param options the request options * @return an HTTP client request object */
HttpClientRequest delete(RequestOptions options);
Create an HTTP DELETE request to send to the server at the specified host and port.
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP DELETE request to send to the server at the specified host and port. * @param port the port * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest delete(int port, String host, String requestURI);
Create an HTTP DELETE request to send to the server at the specified host and default port.
Params:
  • host – the host
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP DELETE request to send to the server at the specified host and default port. * @param host the host * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest delete(String host, String requestURI);
Create an HTTP DELETE request to send to the server with the specified options, specifying a response handler to receive the response
Params:
  • options – the request options
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP DELETE request to send to the server with the specified options, specifying a response handler to receive * the response * @param options the request options * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest delete(RequestOptions options, Handler<HttpClientResponse> responseHandler);
Create an HTTP DELETE request to send to the server at the specified host and port, specifying a response handler to receive the response
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP DELETE request to send to the server at the specified host and port, specifying a response handler to receive * the response * @param port the port * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest delete(int port, String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP DELETE request to send to the server at the specified host and default port, specifying a response handler to receive the response
Params:
  • host – the host
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP DELETE request to send to the server at the specified host and default port, specifying a response handler to receive * the response * @param host the host * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest delete(String host, String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP DELETE request to send to the server at the default host and port.
Params:
  • requestURI – the relative URI
Returns: an HTTP client request object
/** * Create an HTTP DELETE request to send to the server at the default host and port. * @param requestURI the relative URI * @return an HTTP client request object */
HttpClientRequest delete(String requestURI);
Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive the response
Params:
  • requestURI – the relative URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive * the response * @param requestURI the relative URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest delete(String requestURI, Handler<HttpClientResponse> responseHandler);
Create an HTTP DELETE request to send to the server using an absolute URI
Params:
  • absoluteURI – the absolute URI
Returns: an HTTP client request object
/** * Create an HTTP DELETE request to send to the server using an absolute URI * @param absoluteURI the absolute URI * @return an HTTP client request object */
HttpClientRequest deleteAbs(String absoluteURI);
Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
Params:
  • absoluteURI – the absolute URI
  • responseHandler – the response handler
Returns: an HTTP client request object
Deprecated:this method signature will change in Vert.x 4, the handler will use an Handler<AsyncResult<HttpClientResponse>>, you can use instead the WebClient
/** * Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive * the response * @param absoluteURI the absolute URI * @param responseHandler the response handler * @return an HTTP client request object * @deprecated this method signature will change in Vert.x 4, the handler will use an {@code Handler<AsyncResult<HttpClientResponse>>}, * you can use instead the WebClient */
@Deprecated HttpClientRequest deleteAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler);
Connect a WebSocket with the specified options
Params:
  • options – the request options
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options * @param options the request options * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified port, host and relative request URI
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(int, String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI * @param port the port * @param host the host * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(int, String, String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect);
Connect a WebSocket with the specified options
Params:
  • options – the request options
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options * @param options the request options * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified port, host and relative request URI
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(int, String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI * @param port the port * @param host the host * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(int, String, String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the host and relative request URI and default port
Params:
  • host – the host
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the host and relative request URI and default port * @param host the host * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(String, String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, Handler<WebSocket> wsConnect);
Connect a WebSocket to the host and relative request URI and default port
Params:
  • host – the host
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the host and relative request URI and default port * @param host the host * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(String, String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket with the specified options, and with the specified headers
Params:
  • options – the request options
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options, and with the specified headers * @param options the request options * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect);
Connect a WebSocket with the specified options, and with the specified headers
Params:
  • options – the request options
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options, and with the specified headers * @param options the request options * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers * @param host the host * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers * @param host the host * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket with the specified optionsI, with the specified headers and using the specified version of WebSockets
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified optionsI, with the specified headers and using * the specified version of WebSockets * @param options the request options * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using * the specified version of WebSockets * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect);
Connect a WebSocket with the specified options, with the specified headers and using the specified version of WebSockets
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options, with the specified headers and using * the specified version of WebSockets * @param options the request options * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using * the specified version of WebSockets * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using * the specified version of WebSockets * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using the specified version of WebSockets
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using * the specified version of WebSockets * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param options the request options * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect);
Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols.
Params:
  • url – the absolute url
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified absolute url, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols. * * @param url the absolute url * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocketAbs(String url, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket with the specified options, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket with the specified options, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param options the request options * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect);
Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket at the relative request URI using the default host and port
Params:
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, Handler<WebSocket> wsConnect);
Connect a WebSocket at the relative request URI using the default host and port
Params:
  • requestURI – the relative URI
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(String, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port * @param requestURI the relative URI * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(String, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket at the relative request URI using the default host and port and the specified headers
Params:
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port and the specified headers * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, Handler<WebSocket> wsConnect);
Connect a WebSocket at the relative request URI using the default host and port and the specified headers
Params:
  • requestURI – the relative URI
  • headers – the headers
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port and the specified headers * @param requestURI the relative URI * @param headers the headers * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the * specified version of WebSockets * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect);
Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the * specified version of WebSockets * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols
  • wsConnect – handler that will be called with the websocket when connected
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the * specified version of WebSockets and the specified sub protocols * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols * @param wsConnect handler that will be called with the websocket when connected * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect);
Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols
  • wsConnect – handler that will be called with the websocket when connected
  • failureHandler – handler that will be called if websocket connection fails
Returns:a reference to this, so the API can be used fluently
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the * specified version of WebSockets and the specified sub protocols * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols * @param wsConnect handler that will be called with the websocket when connected * @param failureHandler handler that will be called if websocket connection fails * @return a reference to this, so the API can be used fluently * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated @Fluent HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler);
Connect a WebSocket to the specified port, host and relative request URI
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • handler – handler that will be called with the websocket when connected
/** * Connect a WebSocket to the specified port, host and relative request URI * @param port the port * @param host the host * @param requestURI the relative URI * @param handler handler that will be called with the websocket when connected */
void webSocket(int port, String host, String requestURI, Handler<AsyncResult<WebSocket>> handler);
Connect a WebSocket to the host and relative request URI and default port
Params:
  • host – the host
  • requestURI – the relative URI
  • handler – handler that will be called with the websocket when connected
/** * Connect a WebSocket to the host and relative request URI and default port * @param host the host * @param requestURI the relative URI * @param handler handler that will be called with the websocket when connected */
void webSocket(String host, String requestURI, Handler<AsyncResult<WebSocket>> handler);
Connect a WebSocket at the relative request URI using the default host and port
Params:
  • requestURI – the relative URI
  • handler – handler that will be called with the websocket when connected
/** * Connect a WebSocket at the relative request URI using the default host and port * @param requestURI the relative URI * @param handler handler that will be called with the websocket when connected */
void webSocket(String requestURI, Handler<AsyncResult<WebSocket>> handler);
Connect a WebSocket with the specified options.
Params:
  • options – the request options
/** * Connect a WebSocket with the specified options. * * @param options the request options */
void webSocket(WebSocketConnectOptions options, 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.
Params:
  • 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
/** * Connect a WebSocket with the specified absolute url, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols. * * @param url the absolute url * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @param handler handler that will be called if websocket connection fails */
void webSocketAbs(String url, MultiMap headers, WebsocketVersion version, List<String> subProtocols, Handler<AsyncResult<WebSocket>> handler);
Create a WebSocket stream with the specified options
Params:
  • options – the request options
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream with the specified options * @param options the request options * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(RequestOptions options);
Create a WebSocket stream to the specified port, host and relative request URI
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(int, String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified port, host and relative request URI * @param port the port * @param host the host * @param requestURI the relative URI * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(int, String, String, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(int port, String host, String requestURI);
Create a WebSocket stream to the specified host, relative request URI and default port
Params:
  • host – the host
  • requestURI – the relative URI
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(String, String, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified host, relative request URI and default port * @param host the host * @param requestURI the relative URI * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(String, String, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String host, String requestURI);
Create a WebSocket stream with the specified options, and with the specified headers
Params:
  • options – the request options
  • headers – the headers
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream with the specified options, and with the specified headers * @param options the request options * @param headers the headers * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(RequestOptions options, MultiMap headers);
Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(int port, String host, String requestURI, MultiMap headers);
Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers * @param host the host * @param requestURI the relative URI * @param headers the headers * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String host, String requestURI, MultiMap headers);
Create a WebSocket stream with the specified options, with the specified headers and using the specified version of WebSockets
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream with the specified options, with the specified headers and using * the specified version of WebSockets * @param options the request options * @param headers the headers * @param version the websocket version * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version);
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using the specified version of WebSockets
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using * the specified version of WebSockets * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version);
Create a WebSocket stream with the specified options and with the specified headers and using the specified version of WebSockets
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream with the specified options and with the specified headers and using * the specified version of WebSockets * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version);
Create a WebSocket stream with the specified absolute url, the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols.
Params:
  • url – the absolute url
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream with the specified absolute url, the specified headers, using the specified version of WebSockets, * and the specified websocket sub protocols. * * @param url the absolute url * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStreamAbs(String url, MultiMap headers, WebsocketVersion version, String subProtocols);
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • options – the request options
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param options the request options * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(RequestOptions options, MultiMap headers, WebsocketVersion version, String subProtocols);
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • port – the port
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param port the port * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols);
Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
Params:
  • host – the host
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols to use
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using * the specified version of WebSockets, and the specified websocket sub protocols * @param host the host * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols to use * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols);
Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
Params:
  • requestURI – the relative URI
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(String, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream at the relative request URI using the default host and port and the specified headers * @param requestURI the relative URI * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(String, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String requestURI);
Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
Params:
  • requestURI – the relative URI
  • headers – the headers
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream at the relative request URI using the default host and port and the specified headers * @param requestURI the relative URI * @param headers the headers * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String requestURI, MultiMap headers);
Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the specified version of WebSockets
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the * specified version of WebSockets * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String requestURI, MultiMap headers, WebsocketVersion version);
Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the specified version of WebSockets and the specified sub protocols
Params:
  • requestURI – the relative URI
  • headers – the headers
  • version – the websocket version
  • subProtocols – the subprotocols
Returns:a stream emitting a WebSocket event when the client connection has been upgraded to a websocket
Deprecated:use webSocket(WebSocketConnectOptions, Handler<AsyncResult<WebSocket>>) instead
/** * Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the * specified version of WebSockets and the specified sub protocols * @param requestURI the relative URI * @param headers the headers * @param version the websocket version * @param subProtocols the subprotocols * @return a stream emitting a WebSocket event when the client connection has been upgraded to a websocket * @deprecated use {@link #webSocket(WebSocketConnectOptions, Handler)} instead */
@Deprecated ReadStream<WebSocket> websocketStream(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols);
Set a connection handler for the client. This handler is called when a new connection is established.
Returns:a reference to this, so the API can be used fluently
/** * Set a connection handler for the client. This handler is called when a new connection is established. * * @return a reference to this, so the API can be used fluently */
@Fluent HttpClient connectionHandler(Handler<HttpConnection> handler);
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.

Params:
  • handler – the new redirect handler
Returns:a reference to this, so the API can be used fluently
/** * Set a redirect handler for the http client. * <p> * The redirect handler is called when a {@code 3xx} response is received and the request is configured to * follow redirects with {@link HttpClientRequest#setFollowRedirects(boolean)}. * <p> * The redirect handler is passed the {@link HttpClientResponse}, it can return an {@link HttpClientRequest} or {@code null}. * <ul> * <li>when null is returned, the original response is processed by the original request response handler</li> * <li>when a new {@code Future<HttpClientRequest>} is returned, the client will send this new request</li> * </ul> * 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. * <p> * The handler must return a {@code Future<HttpClientRequest>} unsent so the client can further configure it and send it. * * @param handler the new redirect handler * @return a reference to this, so the API can be used fluently */
@Fluent HttpClient redirectHandler(Function<HttpClientResponse, Future<HttpClientRequest>> handler);
Returns:the current redirect handler.
/** * @return the current redirect handler. */
@GenIgnore Function<HttpClientResponse, Future<HttpClientRequest>> redirectHandler();
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.
/** * Close the client. Closing will close down any pooled connections. * Clients should always be closed after use. */
void close(); }