io.vertx.core.http.HttpClient Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2013 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.core.http;
import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.core.metrics.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 {@link io.vertx.core.http.HttpClientOptions} (default is true).
* In this case connections will be pooled and re-used if there are pending HTTP requests waiting to get a connection,
* otherwise they will be closed.
*
* 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 preceeding one has returned. Pipe-lining is not appropriate for all requests.
*
* To enable pipe-lining, it must be enabled on the {@link io.vertx.core.http.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
*/
@VertxGen
public interface HttpClient extends Measured {
/**
* Create an HTTP request to send to the server at the specified host and port.
* @param method the HTTP method
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, int port, String host, String requestURI);
/**
* Create an HTTP request to send to the server at the specified host and default port.
* @param method the HTTP method
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, String host, String requestURI);
/**
* Create an HTTP request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param method the HTTP method
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, int port, String host, String requestURI, Handler 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
* @param method the HTTP method
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP request to send to the server at the default host and port.
* @param method the HTTP method
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, String requestURI);
/**
* Create an HTTP request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param method the HTTP method
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest request(HttpMethod method, String requestURI, Handler responseHandler);
/**
* Create an HTTP request to send to the server using an absolute URI
* @param method the HTTP method
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest requestAbs(HttpMethod method, String absoluteURI);
/**
* Create an HTTP request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param method the HTTP method
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest requestAbs(HttpMethod method, String absoluteURI, Handler responseHandler);
/**
* Create an HTTP GET request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest get(int port, String host, String requestURI);
/**
* Create an HTTP GET request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest get(String host, String requestURI);
/**
* Create an HTTP GET request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest get(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest get(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP GET request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest get(String requestURI);
/**
* Create an HTTP GET request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest get(String requestURI, Handler responseHandler);
/**
* Create an HTTP GET request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest getAbs(String absoluteURI);
/**
* Create an HTTP GET request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest getAbs(String absoluteURI, Handler responseHandler);
/**
* Sends an HTTP GET request to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient getNow(int port, String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP GET request to the server at the specified host and default port, specifying a response handler to receive
* the response
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient getNow(String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP GET request to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient getNow(String requestURI, Handler responseHandler);
/**
* Create an HTTP POST request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest post(int port, String host, String requestURI);
/**
* Create an HTTP POST request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest post(String host, String requestURI);
/**
* Create an HTTP POST request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest post(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest post(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP POST request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest post(String requestURI);
/**
* Create an HTTP POST request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest post(String requestURI, Handler responseHandler);
/**
* Create an HTTP POST request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest postAbs(String absoluteURI);
/**
* Create an HTTP POST request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest postAbs(String absoluteURI, Handler responseHandler);
/**
* Create an HTTP HEAD request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest head(int port, String host, String requestURI);
/**
* Create an HTTP HEAD request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest head(String host, String requestURI);
/**
* Create an HTTP HEAD request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest head(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest head(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP HEAD request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest head(String requestURI);
/**
* Create an HTTP HEAD request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest head(String requestURI, Handler responseHandler);
/**
* Create an HTTP HEAD request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest headAbs(String absoluteURI);
/**
* Create an HTTP HEAD request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest headAbs(String absoluteURI, Handler responseHandler);
/**
* Sends an HTTP HEAD request to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient headNow(int port, String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP HEAD request to the server at the specified host and default port, specifying a response handler to receive
* the response
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient headNow(String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP HEAD request to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient headNow(String requestURI, Handler responseHandler);
/**
* Create an HTTP OPTIONS request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest options(int port, String host, String requestURI);
/**
* Create an HTTP OPTIONS request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest options(String host, String requestURI);
/**
* Create an HTTP OPTIONS request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest options(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest options(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP OPTIONS request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest options(String requestURI);
/**
* Create an HTTP OPTIONS request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest options(String requestURI, Handler responseHandler);
/**
* Create an HTTP OPTIONS request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest optionsAbs(String absoluteURI);
/**
* Create an HTTP OPTIONS request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest optionsAbs(String absoluteURI, Handler responseHandler);
/**
* Sends an HTTP OPTIONS request to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient optionsNow(int port, String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP OPTIONS request to the server at the specified host and default port, specifying a response handler to receive
* the response
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient optionsNow(String host, String requestURI, Handler responseHandler);
/**
* Sends an HTTP OPTIONS request to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient optionsNow(String requestURI, Handler responseHandler);
/**
* Create an HTTP PUT request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest put(int port, String host, String requestURI);
/**
* Create an HTTP PUT request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest put(String host, String requestURI);
/**
* Create an HTTP PUT request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest put(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest put(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP PUT request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest put(String requestURI);
/**
* Create an HTTP PUT request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest put(String requestURI, Handler responseHandler);
/**
* Create an HTTP PUT request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest putAbs(String absoluteURI);
/**
* Create an HTTP PUT request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest putAbs(String absoluteURI, Handler responseHandler);
/**
* Create an HTTP DELETE request to send to the server at the specified host and port.
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest delete(int port, String host, String requestURI);
/**
* Create an HTTP DELETE request to send to the server at the specified host and default port.
* @param host the host
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest delete(String host, String requestURI);
/**
* Create an HTTP DELETE request to send to the server at the specified host and port, specifying a response handler to receive
* the response
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest delete(int port, String host, String requestURI, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest delete(String host, String requestURI, Handler responseHandler);
/**
* Create an HTTP DELETE request to send to the server at the default host and port.
* @param requestURI the relative URI
* @return an HTTP client request object
*/
HttpClientRequest delete(String requestURI);
/**
* Create an HTTP DELETE request to send to the server at the default host and port, specifying a response handler to receive
* the response
* @param requestURI the relative URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest delete(String requestURI, Handler responseHandler);
/**
* Create an HTTP DELETE request to send to the server using an absolute URI
* @param absoluteURI the absolute URI
* @return an HTTP client request object
*/
HttpClientRequest deleteAbs(String absoluteURI);
/**
* Create an HTTP DELETE request to send to the server using an absolute URI, specifying a response handler to receive
* the response
* @param absoluteURI the absolute URI
* @param responseHandler the response handler
* @return an HTTP client request object
*/
HttpClientRequest deleteAbs(String absoluteURI, Handler responseHandler);
/**
* Connect a WebSocket to the specified port, host and relative request URI
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, Handler wsConnect);
/**
* Connect a WebSocket to the specified port, host and relative request URI
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket to the host and relative request URI and default port
* @param host the host
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, Handler wsConnect);
/**
* Connect a WebSocket to the host and relative request URI and default port
* @param host the host
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, Handler wsConnect);
/**
* Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, Handler wsConnect);
/**
* Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using
* the specified version of WebSockets
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version,
Handler wsConnect);
/**
* Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using
* the specified version of WebSockets
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version,
Handler wsConnect, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version,
Handler 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
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version,
Handler wsConnect, Handler 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
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler 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
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler wsConnect, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler 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
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket at the relative request URI using the default host and port
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, Handler wsConnect);
/**
* Connect a WebSocket at the relative request URI using the default host and port
* @param requestURI the relative URI
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket at the relative request URI using the default host and port and the specified headers
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, Handler wsConnect);
/**
* Connect a WebSocket at the relative request URI using the default host and port and the specified headers
* @param requestURI the relative URI
* @param headers the headers
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, Handler wsConnect, Handler failureHandler);
/**
* Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the
* specified version of WebSockets
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version,
Handler wsConnect);
/**
* Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the
* specified version of WebSockets
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version,
Handler wsConnect, Handler 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
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols
* @param wsConnect handler that will be called with the websocket when connected
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler 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
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols
* @param wsConnect handler that will be called with the websocket when connected
* @param failureHandler handler that will be called if websocekt connection fails
* @return a reference to this, so the API can be used fluently
*/
@Fluent
HttpClient websocket(String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols, Handler wsConnect, Handler failureHandler);
/**
* Create a WebSocket stream to the specified port, host and relative request URI
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(int port, String host, String requestURI);
/**
* Create a WebSocket stream to the specified host, relative request URI and default port
* @param host the host
* @param requestURI the relative URI
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String host, String requestURI);
/**
* Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(int port, String host, String requestURI, MultiMap headers);
/**
* Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String host, String requestURI, MultiMap headers);
/**
* Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using
* the specified version of WebSockets
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(int port, 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
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(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, using
* the specified version of WebSockets, and the specified websocket sub protocols
* @param port the port
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(int port, String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols);
/**
* Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using
* the specified version of WebSockets, and the specified websocket sub protocols
* @param host the host
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols to use
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String host, String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols);
/**
* Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
* @param requestURI the relative URI
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String requestURI);
/**
* Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
* @param requestURI the relative URI
* @param headers the headers
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String requestURI, MultiMap headers);
/**
* Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the
* specified version of WebSockets
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @return a reference to this, so the API can be used fluently
*/
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, the
* specified version of WebSockets and the specified sub protocols
* @param requestURI the relative URI
* @param headers the headers
* @param version the websocket version
* @param subProtocols the subprotocols
* @return a reference to this, so the API can be used fluently
*/
WebSocketStream websocketStream(String requestURI, MultiMap headers, WebsocketVersion version,
String subProtocols);
/**
* Close the client. Closing will close down any pooled connections.
* Clients should always be closed after use.
*/
void close();
}