Package io.vertx.mutiny.core.http

Class HttpClient

  • All Implemented Interfaces:
    Measured
    public class HttpClient
extends Object
implements Measured
    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.

    NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

    • Constructor Detail

      • HttpClient

        public HttpClient​(io.vertx.core.http.HttpClient delegate)

    • Method Detail

      • getDelegate

        public io.vertx.core.http.HttpClient getDelegate()
        Specified by:
        getDelegate in interface Measured

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • isMetricsEnabled

        public boolean isMetricsEnabled()
        Specified by:
        isMetricsEnabled in interface Measured
        Returns:
        true if metrics are enabled

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 SocketAddress serverAddress,
                                 io.vertx.core.http.RequestOptions options)
        Parameters:
        method -
        serverAddress -
        options -
        Returns:

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 io.vertx.core.http.RequestOptions options)
        Parameters:
        method - the HTTP method
        options - the request options
        Returns:
        an HTTP client request object

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 int port,
                                 String host,
                                 String requestURI)
        Parameters:
        method - the HTTP method
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 SocketAddress serverAddress,
                                 int port,
                                 String host,
                                 String requestURI)
        Parameters:
        method -
        serverAddress -
        port -
        host -
        requestURI -
        Returns:

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 String host,
                                 String requestURI)
        Parameters:
        method - the HTTP method
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • request

        @Deprecated
public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 io.vertx.core.http.RequestOptions options,
                                 Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        method - the HTTP method
        options - the request options
        responseHandler -
        Returns:
        an HTTP client request object

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 SocketAddress serverAddress,
                                 io.vertx.core.http.RequestOptions options,
                                 Consumer<HttpClientResponse> responseHandler)
        Parameters:
        method -
        serverAddress -
        options -
        responseHandler -
        Returns:

      • request

        @Deprecated
public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 int port,
                                 String host,
                                 String requestURI,
                                 Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        method - the HTTP method
        port - the port
        host - the host
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • request

        @Deprecated
public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 String host,
                                 String requestURI,
                                 Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        method - the HTTP method
        host - the host
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • request

        public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 String requestURI)
        Parameters:
        method - the HTTP method
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • request

        @Deprecated
public HttpClientRequest request​(io.vertx.core.http.HttpMethod method,
                                 String requestURI,
                                 Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        method - the HTTP method
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • requestAbs

        public HttpClientRequest requestAbs​(io.vertx.core.http.HttpMethod method,
                                    String absoluteURI)
        Parameters:
        method - the HTTP method
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • requestAbs

        public HttpClientRequest requestAbs​(io.vertx.core.http.HttpMethod method,
                                    SocketAddress serverAddress,
                                    String absoluteURI)
        Parameters:
        method -
        serverAddress -
        absoluteURI -
        Returns:

      • requestAbs

        @Deprecated
public HttpClientRequest requestAbs​(io.vertx.core.http.HttpMethod method,
                                    String absoluteURI,
                                    Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        method - the HTTP method
        absoluteURI - the absolute URI
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • get

        public HttpClientRequest get​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • get

        public HttpClientRequest get​(int port,
                             String host,
                             String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • get

        public HttpClientRequest get​(String host,
                             String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • get

        @Deprecated
public HttpClientRequest get​(io.vertx.core.http.RequestOptions options,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • get

        public HttpClientRequest get​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • getAbs

        public HttpClientRequest getAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • getNow

        @Deprecated
public HttpClient getNow​(io.vertx.core.http.RequestOptions options,
                         Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • getNow

        @Deprecated
public HttpClient getNow​(int port,
                         String host,
                         String requestURI,
                         Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        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

      • getNow

        @Deprecated
public HttpClient getNow​(String host,
                         String requestURI,
                         Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        host - the host
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • getNow

        @Deprecated
public HttpClient getNow​(String requestURI,
                         Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • post

        public HttpClientRequest post​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • post

        public HttpClientRequest post​(int port,
                              String host,
                              String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • post

        public HttpClientRequest post​(String host,
                              String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • post

        @Deprecated
public HttpClientRequest post​(io.vertx.core.http.RequestOptions options,
                              Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • post

        public HttpClientRequest post​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • postAbs

        public HttpClientRequest postAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • head

        public HttpClientRequest head​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • head

        public HttpClientRequest head​(int port,
                              String host,
                              String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • head

        public HttpClientRequest head​(String host,
                              String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • head

        @Deprecated
public HttpClientRequest head​(io.vertx.core.http.RequestOptions options,
                              Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • head

        public HttpClientRequest head​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • headAbs

        public HttpClientRequest headAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • headNow

        @Deprecated
public HttpClient headNow​(io.vertx.core.http.RequestOptions options,
                          Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • headNow

        @Deprecated
public HttpClient headNow​(int port,
                          String host,
                          String requestURI,
                          Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        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

      • headNow

        @Deprecated
public HttpClient headNow​(String host,
                          String requestURI,
                          Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        host - the host
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • headNow

        @Deprecated
public HttpClient headNow​(String requestURI,
                          Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • options

        public HttpClientRequest options​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • options

        public HttpClientRequest options​(int port,
                                 String host,
                                 String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • options

        public HttpClientRequest options​(String host,
                                 String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • options

        @Deprecated
public HttpClientRequest options​(io.vertx.core.http.RequestOptions options,
                                 Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • options

        public HttpClientRequest options​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • optionsAbs

        public HttpClientRequest optionsAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • optionsNow

        @Deprecated
public HttpClient optionsNow​(io.vertx.core.http.RequestOptions options,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • optionsNow

        @Deprecated
public HttpClient optionsNow​(int port,
                             String host,
                             String requestURI,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        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

      • optionsNow

        @Deprecated
public HttpClient optionsNow​(String host,
                             String requestURI,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        host - the host
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • optionsNow

        @Deprecated
public HttpClient optionsNow​(String requestURI,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        requestURI - the relative URI
        responseHandler - the response handler
        Returns:
        a reference to this, so the API can be used fluently

      • put

        public HttpClientRequest put​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • put

        public HttpClientRequest put​(int port,
                             String host,
                             String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • put

        public HttpClientRequest put​(String host,
                             String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • put

        @Deprecated
public HttpClientRequest put​(io.vertx.core.http.RequestOptions options,
                             Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • put

        public HttpClientRequest put​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • putAbs

        public HttpClientRequest putAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • delete

        public HttpClientRequest delete​(io.vertx.core.http.RequestOptions options)
        Parameters:
        options - the request options
        Returns:
        an HTTP client request object

      • delete

        public HttpClientRequest delete​(int port,
                                String host,
                                String requestURI)
        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • delete

        public HttpClientRequest delete​(String host,
                                String requestURI)
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • delete

        @Deprecated
public HttpClientRequest delete​(io.vertx.core.http.RequestOptions options,
                                Consumer<HttpClientResponse> responseHandler)
        Deprecated.
        Parameters:
        options - the request options
        responseHandler - the response handler
        Returns:
        an HTTP client request object

      • delete

        public HttpClientRequest delete​(String requestURI)
        Parameters:
        requestURI - the relative URI
        Returns:
        an HTTP client request object

      • deleteAbs

        public HttpClientRequest deleteAbs​(String absoluteURI)
        Parameters:
        absoluteURI - the absolute URI
        Returns:
        an HTTP client request object

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocketAbs

        @Deprecated
public HttpClient websocketAbs​(String url,
                               MultiMap headers,
                               io.vertx.core.http.WebsocketVersion version,
                               String subProtocols,
                               io.vertx.core.Handler<WebSocket> wsConnect,
                               Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(io.vertx.core.http.RequestOptions options,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(int port,
                            String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String host,
                            String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            Consumer<WebSocket> wsConnect)
        Deprecated.
        Parameters:
        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

      • websocket

        @Deprecated
public HttpClient websocket​(String requestURI,
                            MultiMap headers,
                            io.vertx.core.http.WebsocketVersion version,
                            String subProtocols,
                            io.vertx.core.Handler<WebSocket> wsConnect,
                            Consumer<Throwable> failureHandler)
        Deprecated.
        Parameters:
        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

      • webSocket

        public io.smallrye.mutiny.Uni<WebSocket> webSocket​(int port,
                                                   String host,
                                                   String requestURI)
        Connect a WebSocket to the specified port, host and relative request URI

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • webSocketAndAwait

        public WebSocket webSocketAndAwait​(int port,
                                   String host,
                                   String requestURI)
        Blocking variant of webSocket(int,String,String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        port - the port
        host - the host
        requestURI - the relative URI
        Returns:
        the WebSocket instance produced by the operation

      • webSocket

        public io.smallrye.mutiny.Uni<WebSocket> webSocket​(String host,
                                                   String requestURI)
        Connect a WebSocket to the host and relative request URI and default port

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • webSocketAndAwait

        public WebSocket webSocketAndAwait​(String host,
                                   String requestURI)
        Blocking variant of webSocket(String,String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        the WebSocket instance produced by the operation

      • webSocket

        public io.smallrye.mutiny.Uni<WebSocket> webSocket​(String requestURI)
        Connect a WebSocket at the relative request URI using the default host and port

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        requestURI - the relative URI
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • webSocketAndAwait

        public WebSocket webSocketAndAwait​(String requestURI)
        Blocking variant of webSocket(String).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        requestURI - the relative URI
        Returns:
        the WebSocket instance produced by the operation

      • webSocket

        public io.smallrye.mutiny.Uni<WebSocket> webSocket​(io.vertx.core.http.WebSocketConnectOptions options)
        Connect a WebSocket with the specified options.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        options - the request options
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • webSocketAndAwait

        public WebSocket webSocketAndAwait​(io.vertx.core.http.WebSocketConnectOptions options)
        Blocking variant of webSocket(WebSocketConnectOptions).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        options - the request options
        Returns:
        the WebSocket instance produced by the operation

      • webSocketAbs

        public io.smallrye.mutiny.Uni<WebSocket> webSocketAbs​(String url,
                                                      MultiMap headers,
                                                      io.vertx.core.http.WebsocketVersion version,
                                                      List<String> subProtocols)
        Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified WebSocket sub protocols.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Parameters:
        url - the absolute url
        headers - the headers
        version - the WebSocket version
        subProtocols - the subprotocols to use
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • webSocketAbsAndAwait

        public WebSocket webSocketAbsAndAwait​(String url,
                                      MultiMap headers,
                                      io.vertx.core.http.WebsocketVersion version,
                                      List<String> subProtocols)
        Blocking variant of io.vertx.mutiny.core.http.HttpClient#webSocketAbs(String,io.vertx.mutiny.core.MultiMap,WebsocketVersion,List).

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Parameters:
        url - the absolute url
        headers - the headers
        version - the WebSocket version
        subProtocols - the subprotocols to use
        Returns:
        the WebSocket instance produced by the operation

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(io.vertx.core.http.RequestOptions options)
        Deprecated.
        Parameters:
        options - the request options
        Returns:
        a stream emitting a WebSocket event when the client connection has been upgraded to a WebSocket

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(int port,
                                             String host,
                                             String requestURI)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String host,
                                             String requestURI)
        Deprecated.
        Parameters:
        host - the host
        requestURI - the relative URI
        Returns:
        a stream emitting a WebSocket event when the client connection has been upgraded to a WebSocket

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(io.vertx.core.http.RequestOptions options,
                                             MultiMap headers)
        Deprecated.
        Parameters:
        options - the request options
        headers - the headers
        Returns:
        a stream emitting a WebSocket event when the client connection has been upgraded to a WebSocket

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(int port,
                                             String host,
                                             String requestURI,
                                             MultiMap headers)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String host,
                                             String requestURI,
                                             MultiMap headers)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(io.vertx.core.http.RequestOptions options,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(int port,
                                             String host,
                                             String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String host,
                                             String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version)
        Deprecated.
        Parameters:
        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

      • websocketStreamAbs

        @Deprecated
public ReadStream<WebSocket> websocketStreamAbs​(String url,
                                                MultiMap headers,
                                                io.vertx.core.http.WebsocketVersion version,
                                                String subProtocols)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(io.vertx.core.http.RequestOptions options,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version,
                                             String subProtocols)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(int port,
                                             String host,
                                             String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version,
                                             String subProtocols)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String host,
                                             String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version,
                                             String subProtocols)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String requestURI)
        Deprecated.
        Parameters:
        requestURI - the relative URI
        Returns:
        a stream emitting a WebSocket event when the client connection has been upgraded to a WebSocket

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String requestURI,
                                             MultiMap headers)
        Deprecated.
        Parameters:
        requestURI - the relative URI
        headers - the headers
        Returns:
        a stream emitting a WebSocket event when the client connection has been upgraded to a WebSocket

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version)
        Deprecated.
        Parameters:
        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

      • websocketStream

        @Deprecated
public ReadStream<WebSocket> websocketStream​(String requestURI,
                                             MultiMap headers,
                                             io.vertx.core.http.WebsocketVersion version,
                                             String subProtocols)
        Deprecated.
        Parameters:
        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

      • connectionHandler

        public HttpClient connectionHandler​(Consumer<HttpConnection> handler)
        Parameters:
        handler -
        Returns:
        a reference to this, so the API can be used fluently

      • close

        public void close()

      • newInstance

        public static HttpClient newInstance​(io.vertx.core.http.HttpClient arg)