io.vertx.core.http

Interface HttpClient

All Superinterfaces:

Measured

public interface HttpClient
extends 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.

Author:

Tim Fox

Method Summary

Modifier and Type	Method and Description
void	close() Close the client.
HttpClientRequest	delete(int port, String host, String requestURI) Create an HTTP DELETE request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	delete(String requestURI) Create an HTTP DELETE request to send to the server at the default host and port.
HttpClientRequest	delete(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	delete(String host, String requestURI) Create an HTTP DELETE request to send to the server at the specified host and default port.
HttpClientRequest	delete(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
HttpClientRequest	deleteAbs(String absoluteURI) Create an HTTP DELETE request to send to the server using an absolute URI
HttpClientRequest	deleteAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClientRequest	get(int port, String host, String requestURI) Create an HTTP GET request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	get(String requestURI) Create an HTTP GET request to send to the server at the default host and port.
HttpClientRequest	get(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	get(String host, String requestURI) Create an HTTP GET request to send to the server at the specified host and default port.
HttpClientRequest	get(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
HttpClientRequest	getAbs(String absoluteURI) Create an HTTP GET request to send to the server using an absolute URI
HttpClientRequest	getAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClient	getNow(int port, String host, String requestURI, 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
HttpClient	getNow(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
HttpClient	getNow(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
HttpClientRequest	head(int port, String host, String requestURI) Create an HTTP HEAD request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	head(String requestURI) Create an HTTP HEAD request to send to the server at the default host and port.
HttpClientRequest	head(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	head(String host, String requestURI) Create an HTTP HEAD request to send to the server at the specified host and default port.
HttpClientRequest	head(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
HttpClientRequest	headAbs(String absoluteURI) Create an HTTP HEAD request to send to the server using an absolute URI
HttpClientRequest	headAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClient	headNow(int port, String host, String requestURI, 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
HttpClient	headNow(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
HttpClient	headNow(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
HttpClientRequest	options(int port, String host, String requestURI) Create an HTTP OPTIONS request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	options(String requestURI) Create an HTTP OPTIONS request to send to the server at the default host and port.
HttpClientRequest	options(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	options(String host, String requestURI) Create an HTTP OPTIONS request to send to the server at the specified host and default port.
HttpClientRequest	options(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
HttpClientRequest	optionsAbs(String absoluteURI) Create an HTTP OPTIONS request to send to the server using an absolute URI
HttpClientRequest	optionsAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClient	optionsNow(int port, String host, String requestURI, 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
HttpClient	optionsNow(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
HttpClient	optionsNow(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
HttpClientRequest	post(int port, String host, String requestURI) Create an HTTP POST request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	post(String requestURI) Create an HTTP POST request to send to the server at the default host and port.
HttpClientRequest	post(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	post(String host, String requestURI) Create an HTTP POST request to send to the server at the specified host and default port.
HttpClientRequest	post(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
HttpClientRequest	postAbs(String absoluteURI) Create an HTTP POST request to send to the server using an absolute URI
HttpClientRequest	postAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClientRequest	put(int port, String host, String requestURI) Create an HTTP PUT request to send to the server at the specified host and port.
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 port, specifying a response handler to receive the response
HttpClientRequest	put(String requestURI) Create an HTTP PUT request to send to the server at the default host and port.
HttpClientRequest	put(String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	put(String host, String requestURI) Create an HTTP PUT request to send to the server at the specified host and default port.
HttpClientRequest	put(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
HttpClientRequest	putAbs(String absoluteURI) Create an HTTP PUT request to send to the server using an absolute URI
HttpClientRequest	putAbs(String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClientRequest	request(HttpMethod method, int port, String host, String requestURI) Create an HTTP request to send to the server at the specified host and port.
HttpClientRequest	request(HttpMethod method, int port, String host, String requestURI, 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
HttpClientRequest	request(HttpMethod method, String requestURI) Create an HTTP request to send to the server at the default host and port.
HttpClientRequest	request(HttpMethod method, String requestURI, Handler<HttpClientResponse> responseHandler) Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive the response
HttpClientRequest	request(HttpMethod method, String host, String requestURI) Create an HTTP request to send to the server at the specified host and default port.
HttpClientRequest	request(HttpMethod method, 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
HttpClientRequest	requestAbs(HttpMethod method, String absoluteURI) Create an HTTP request to send to the server using an absolute URI
HttpClientRequest	requestAbs(HttpMethod method, String absoluteURI, Handler<HttpClientResponse> responseHandler) Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive the response
HttpClient	websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect) Connect a WebSocket to the specified port, host and relative request URI
HttpClient	websocket(int port, String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler) Connect a WebSocket to the specified port, host and relative request URI
HttpClient	websocket(int port, String host, String requestURI, MultiMap headers, Handler<WebSocket> wsConnect) Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
HttpClient	websocket(int port, String host, String requestURI, 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
HttpClient	websocket(int port, String host, String requestURI, 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
HttpClient	websocket(int port, String host, String requestURI, 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
HttpClient	websocket(int port, String host, String requestURI, 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
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 port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols
HttpClient	websocket(String requestURI, Handler<WebSocket> wsConnect) Connect a WebSocket at the relative request URI using the default host and port
HttpClient	websocket(String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler) Connect a WebSocket at the relative request URI using the default host and port
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
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 and the specified headers
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
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 and the specified version of WebSockets
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
HttpClient	websocket(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, the specified headers, the specified version of WebSockets and the specified sub protocols
HttpClient	websocket(String host, String requestURI, Handler<WebSocket> wsConnect) Connect a WebSocket to the host and relative request URI and default port
HttpClient	websocket(String host, String requestURI, Handler<WebSocket> wsConnect, Handler<Throwable> failureHandler) Connect a WebSocket to the host and relative request URI and default port
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
HttpClient	websocket(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
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
HttpClient	websocket(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
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
HttpClient	websocket(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
WebSocketStream	websocketStream(int port, String host, String requestURI) Create a WebSocket stream to the specified port, host and relative request URI
WebSocketStream	websocketStream(int port, String host, String requestURI, MultiMap headers) Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
WebSocketStream	websocketStream(int port, String host, String requestURI, 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
WebSocketStream	websocketStream(int port, String host, String requestURI, 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
WebSocketStream	websocketStream(String requestURI) Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
WebSocketStream	websocketStream(String requestURI, MultiMap headers) Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
WebSocketStream	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 and the specified version of WebSockets
WebSocketStream	websocketStream(String requestURI, MultiMap headers, WebsocketVersion version, String subProtocols) 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
WebSocketStream	websocketStream(String host, String requestURI) Create a WebSocket stream to the specified host, relative request URI and default port
WebSocketStream	websocketStream(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
WebSocketStream	websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version) Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers and using the specified version of WebSockets
WebSocketStream	websocketStream(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

Methods inherited from interface io.vertx.core.metrics.Measured

isMetricsEnabled

Method Detail

request

HttpClientRequest request(HttpMethod method,
                          int port,
                          String host,
                          String requestURI)

Create an HTTP request to send to the server at the specified host and port.

Parameters:

method - the HTTP method

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

request

HttpClientRequest request(HttpMethod method,
                          String host,
                          String requestURI)

Create an HTTP request to send to the server at the specified host and default port.

Parameters:

method - the HTTP method

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

request

HttpClientRequest request(HttpMethod method,
                          int port,
                          String host,
                          String requestURI,
                          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

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

HttpClientRequest request(HttpMethod method,
                          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

Parameters:

method - the HTTP method

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

request

HttpClientRequest request(HttpMethod method,
                          String requestURI)

Create an HTTP request to send to the server at the default host and port.

Parameters:

method - the HTTP method

requestURI - the relative URI

Returns:

an HTTP client request object

request

HttpClientRequest request(HttpMethod method,
                          String requestURI,
                          Handler<HttpClientResponse> responseHandler)

Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

method - the HTTP method

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

requestAbs

HttpClientRequest requestAbs(HttpMethod method,
                             String absoluteURI)

Create an HTTP request to send to the server using an absolute URI

Parameters:

method - the HTTP method

absoluteURI - the absolute URI

Returns:

an HTTP client request object

requestAbs

HttpClientRequest requestAbs(HttpMethod method,
                             String absoluteURI,
                             Handler<HttpClientResponse> responseHandler)

Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

method - the HTTP method

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

get

HttpClientRequest get(int port,
                      String host,
                      String requestURI)

Create an HTTP GET request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

get

HttpClientRequest get(String host,
                      String requestURI)

Create an HTTP GET request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

get

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

get

HttpClientRequest get(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

get

HttpClientRequest get(String requestURI)

Create an HTTP GET request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

get

HttpClientRequest get(String requestURI,
                      Handler<HttpClientResponse> responseHandler)

Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

getAbs

HttpClientRequest getAbs(String absoluteURI)

Create an HTTP GET request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

getAbs

HttpClientRequest getAbs(String absoluteURI,
                         Handler<HttpClientResponse> responseHandler)

Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

getNow

HttpClient getNow(int port,
                  String host,
                  String requestURI,
                  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

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

HttpClient getNow(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

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

HttpClient getNow(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

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

a reference to this, so the API can be used fluently

post

HttpClientRequest post(int port,
                       String host,
                       String requestURI)

Create an HTTP POST request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

post

HttpClientRequest post(String host,
                       String requestURI)

Create an HTTP POST request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

post

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

post

HttpClientRequest post(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

post

HttpClientRequest post(String requestURI)

Create an HTTP POST request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

post

HttpClientRequest post(String requestURI,
                       Handler<HttpClientResponse> responseHandler)

Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

postAbs

HttpClientRequest postAbs(String absoluteURI)

Create an HTTP POST request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

postAbs

HttpClientRequest postAbs(String absoluteURI,
                          Handler<HttpClientResponse> responseHandler)

Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

head

HttpClientRequest head(int port,
                       String host,
                       String requestURI)

Create an HTTP HEAD request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

head

HttpClientRequest head(String host,
                       String requestURI)

Create an HTTP HEAD request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

head

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

head

HttpClientRequest head(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

head

HttpClientRequest head(String requestURI)

Create an HTTP HEAD request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

head

HttpClientRequest head(String requestURI,
                       Handler<HttpClientResponse> responseHandler)

Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

headAbs

HttpClientRequest headAbs(String absoluteURI)

Create an HTTP HEAD request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

headAbs

HttpClientRequest headAbs(String absoluteURI,
                          Handler<HttpClientResponse> responseHandler)

Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

headNow

HttpClient headNow(int port,
                   String host,
                   String requestURI,
                   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

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

HttpClient headNow(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

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

HttpClient headNow(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

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

a reference to this, so the API can be used fluently

options

HttpClientRequest options(int port,
                          String host,
                          String requestURI)

Create an HTTP OPTIONS request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

options

HttpClientRequest options(String host,
                          String requestURI)

Create an HTTP OPTIONS request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

options

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

options

HttpClientRequest options(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

options

HttpClientRequest options(String requestURI)

Create an HTTP OPTIONS request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

options

HttpClientRequest options(String requestURI,
                          Handler<HttpClientResponse> responseHandler)

Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

optionsAbs

HttpClientRequest optionsAbs(String absoluteURI)

Create an HTTP OPTIONS request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

optionsAbs

HttpClientRequest optionsAbs(String absoluteURI,
                             Handler<HttpClientResponse> responseHandler)

Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

optionsNow

HttpClient optionsNow(int port,
                      String host,
                      String requestURI,
                      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

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

HttpClient optionsNow(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

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

HttpClient optionsNow(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

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

a reference to this, so the API can be used fluently

put

HttpClientRequest put(int port,
                      String host,
                      String requestURI)

Create an HTTP PUT request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

put

HttpClientRequest put(String host,
                      String requestURI)

Create an HTTP PUT request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

put

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

put

HttpClientRequest put(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

put

HttpClientRequest put(String requestURI)

Create an HTTP PUT request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

put

HttpClientRequest put(String requestURI,
                      Handler<HttpClientResponse> responseHandler)

Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

putAbs

HttpClientRequest putAbs(String absoluteURI)

Create an HTTP PUT request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

putAbs

HttpClientRequest putAbs(String absoluteURI,
                         Handler<HttpClientResponse> responseHandler)

Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

delete

HttpClientRequest delete(int port,
                         String host,
                         String requestURI)

Create an HTTP DELETE request to send to the server at the specified host and port.

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

delete

HttpClientRequest delete(String host,
                         String requestURI)

Create an HTTP DELETE request to send to the server at the specified host and default port.

Parameters:

host - the host

requestURI - the relative URI

Returns:

an HTTP client request object

delete

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 port, specifying a response handler to receive the response

Parameters:

port - the port

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

delete

HttpClientRequest delete(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

Parameters:

host - the host

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

delete

HttpClientRequest delete(String requestURI)

Create an HTTP DELETE request to send to the server at the default host and port.

Parameters:

requestURI - the relative URI

Returns:

an HTTP client request object

delete

HttpClientRequest delete(String requestURI,
                         Handler<HttpClientResponse> responseHandler)

Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive the response

Parameters:

requestURI - the relative URI

responseHandler - the response handler

Returns:

an HTTP client request object

deleteAbs

HttpClientRequest deleteAbs(String absoluteURI)

Create an HTTP DELETE request to send to the server using an absolute URI

Parameters:

absoluteURI - the absolute URI

Returns:

an HTTP client request object

deleteAbs

HttpClientRequest deleteAbs(String absoluteURI,
                            Handler<HttpClientResponse> responseHandler)

Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive the response

Parameters:

absoluteURI - the absolute URI

responseHandler - the response handler

Returns:

an HTTP client request object

websocket

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     Handler<WebSocket> wsConnect)

Connect a WebSocket to the specified port, host and relative request URI

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     Handler<WebSocket> wsConnect,
                     Handler<Throwable> failureHandler)

Connect a WebSocket to the specified port, host and relative request URI

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

HttpClient websocket(String host,
                     String requestURI,
                     Handler<WebSocket> wsConnect)

Connect a WebSocket to the host and relative request URI and default port

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

HttpClient websocket(String host,
                     String requestURI,
                     Handler<WebSocket> wsConnect,
                     Handler<Throwable> failureHandler)

Connect a WebSocket to the host and relative request URI and default port

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     MultiMap headers,
                     Handler<WebSocket> wsConnect)

Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     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

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

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

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

HttpClient websocket(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

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     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

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     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

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

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

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

HttpClient websocket(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

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

HttpClient websocket(int port,
                     String host,
                     String requestURI,
                     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

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

websocket

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 port, host and relative request URI, with the specified headers, using the specified version of WebSockets, and the specified websocket sub protocols

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

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

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

HttpClient websocket(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

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

HttpClient websocket(String requestURI,
                     Handler<WebSocket> wsConnect)

Connect a WebSocket at the relative request URI using the default host and port

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

HttpClient websocket(String requestURI,
                     Handler<WebSocket> wsConnect,
                     Handler<Throwable> failureHandler)

Connect a WebSocket at the relative request URI using the default host and port

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

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

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

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 and the specified headers

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

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

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

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 and the specified version of WebSockets

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

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

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

HttpClient websocket(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, the specified headers, the specified version of WebSockets and the specified sub protocols

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

websocketStream

WebSocketStream websocketStream(int port,
                                String host,
                                String requestURI)

Create a WebSocket stream to the specified port, host and relative request URI

Parameters:

port - the port

host - the host

requestURI - the relative URI

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(String host,
                                String requestURI)

Create a WebSocket stream to the specified host, relative request URI and default port

Parameters:

host - the host

requestURI - the relative URI

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(int port,
                                String host,
                                String requestURI,
                                MultiMap headers)

Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers

Parameters:

port - the port

host - the host

requestURI - the relative URI

headers - the headers

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(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

Parameters:

host - the host

requestURI - the relative URI

headers - the headers

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(int port,
                                String host,
                                String requestURI,
                                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

Parameters:

port - the port

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(String host,
                                String requestURI,
                                MultiMap headers,
                                WebsocketVersion version)

Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers and using the specified version of WebSockets

Parameters:

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(int port,
                                String host,
                                String requestURI,
                                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

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 reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(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

Parameters:

host - the host

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols to use

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(String requestURI)

Create a WebSocket stream at the relative request URI using the default host and port and the specified headers

Parameters:

requestURI - the relative URI

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(String requestURI,
                                MultiMap headers)

Create a WebSocket stream at the relative request URI using the default host and port and the specified headers

Parameters:

requestURI - the relative URI

headers - the headers

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream 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 and the specified version of WebSockets

Parameters:

requestURI - the relative URI

headers - the headers

version - the websocket version

Returns:

a reference to this, so the API can be used fluently

websocketStream

WebSocketStream websocketStream(String requestURI,
                                MultiMap headers,
                                WebsocketVersion version,
                                String subProtocols)

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

Parameters:

requestURI - the relative URI

headers - the headers

version - the websocket version

subProtocols - the subprotocols

Returns:

a reference to this, so the API can be used fluently

close

void close()

Close the client. Closing will close down any pooled connections. Clients should always be closed after use.