vertx / io.vertx.ext.web.client

Package io.vertx.ext.web.client

Types

HttpRequest

interface HttpRequest<T : Any>

A client-side HTTP request.

Instances are created by an WebClient instance, via one of the methods corresponding to the specific HTTP methods such as WebClient#get, etc...

The request shall be configured prior sending, the request is immutable and when a mutator method is called, a new request is returned allowing to expose the request in a public API and apply further customization.

After the request has been configured, the methods

can be called. The sendXXX methods perform the actual request, they can be called multiple times to perform the same HTTP request at different points in time.

The handler is called back with

  • an HttpResponse instance when the HTTP response has been received
  • a failure when the HTTP request failed (like a connection error) or when the HTTP response could not be obtained (like connection or unmarshalling errors)

Most of the time, this client will buffer the HTTP response fully unless a specific BodyCodec is used such as BodyCodec#create(Handler).

WebClientOptionsConverter

open class WebClientOptionsConverter

Converter for io.vertx.ext.web.client.WebClientOptions. NOTE: This class has been automatically generated from the io.vertx.ext.web.client.WebClientOptions original class using Vert.x codegen.