vertx / io.vertx.rxjava.ext.web.client / WebClient

WebClient

open class WebClient

An asynchronous HTTP / HTTP/2 client called WebClient.

The web client makes easy to do HTTP request/response interactions with a web server, and provides advanced features like:

The web client does not deprecate the , it is actually based on it and therefore inherits its configuration and great features like pooling. The HttpClient should be used when fine grained control over the HTTP requests/response is necessary.

NOTE: This class has been automatically generated from the io.vertx.ext.web.client.WebClient non RX-ified interface using Vert.x codegen.

Constructors

<init>

WebClient(delegate: WebClient)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<WebClient>

Functions

close

open fun close(): Unit

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

create

open static fun create(vertx: Vertx): WebClient

Create a web client using the provided vertx instance and default options.

open static fun create(vertx: Vertx, options: WebClientOptions): WebClient

Create a web client using the provided vertx instance.

delete

open fun delete(requestURI: String): HttpRequest<Buffer>

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

open fun delete(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun delete(host: String, requestURI: String): HttpRequest<Buffer>

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

deleteAbs

open fun deleteAbs(absoluteURI: String): HttpRequest<Buffer>

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

equals

open fun equals(other: Any?): Boolean

get

open fun get(requestURI: String): HttpRequest<Buffer>

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

open fun get(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun get(host: String, requestURI: String): HttpRequest<Buffer>

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

getAbs

open fun getAbs(absoluteURI: String): HttpRequest<Buffer>

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

getDelegate

open fun getDelegate(): WebClient

hashCode

open fun hashCode(): Int

head

open fun head(requestURI: String): HttpRequest<Buffer>

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

open fun head(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun head(host: String, requestURI: String): HttpRequest<Buffer>

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

headAbs

open fun headAbs(absoluteURI: String): HttpRequest<Buffer>

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

newInstance

open static fun newInstance(arg: WebClient): WebClient

patch

open fun patch(requestURI: String): HttpRequest<Buffer>

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

open fun patch(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun patch(host: String, requestURI: String): HttpRequest<Buffer>

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

patchAbs

open fun patchAbs(absoluteURI: String): HttpRequest<Buffer>

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

post

open fun post(requestURI: String): HttpRequest<Buffer>

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

open fun post(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun post(host: String, requestURI: String): HttpRequest<Buffer>

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

postAbs

open fun postAbs(absoluteURI: String): HttpRequest<Buffer>

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

put

open fun put(requestURI: String): HttpRequest<Buffer>

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

open fun put(port: Int, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun put(host: String, requestURI: String): HttpRequest<Buffer>

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

putAbs

open fun putAbs(absoluteURI: String): HttpRequest<Buffer>

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

request

open fun request(method: HttpMethod, port: Int, host: String, requestURI: String): HttpRequest<Buffer>
open fun request(method: HttpMethod, options: RequestOptions): HttpRequest<Buffer>

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

open fun request(method: HttpMethod, host: String, requestURI: String): HttpRequest<Buffer>

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

open fun request(method: HttpMethod, requestURI: String): HttpRequest<Buffer>

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

requestAbs

open fun requestAbs(method: HttpMethod, absoluteURI: String): HttpRequest<Buffer>

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

toString

open fun toString(): String

wrap

open static fun wrap(httpClient: HttpClient): WebClient

Wrap an httpClient with a web client and default options.

open static fun wrap(httpClient: HttpClient, options: WebClientOptions): WebClient

Wrap an httpClient with a web client and default options.

Only the specific web client portion of the options is used, the io.vertx.core.http.HttpClientOptions of the httpClient is reused.