HttpClient | @vertx/core

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.

Hierarchy

HttpClient

Implements

Measured

Index

Methods

close

close(): PromiseLike<void>
close(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3264
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3270
Close the client. Closing will close down any pooled connections. Clients should always be closed after use.

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

connectionHandler

connectionHandler(handler: ((res: HttpConnection) => void) | Handler<HttpConnection>): HttpClient

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3240
Set a connection handler for the client. This handler is called when a new connection is established.

Parameters
- handler: ((res: HttpConnection) => void) | Handler<HttpConnection>
Returns HttpClient

isMetricsEnabled

isMetricsEnabled(): boolean

Implementation of Measured.isMetricsEnabled
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3123
Whether the metrics are enabled for this measured object

Returns boolean

redirectHandler

redirectHandler(handler: (arg: HttpClientResponse) => PromiseLike<RequestOptions>): HttpClient

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3258
Set a redirect handler for the http client.

The redirect handler is called when a 3xx response is received and the request is configured to follow redirects with {@link HttpClientRequest#setFollowRedirects}.
The redirect handler is passed the HttpClientResponse, it can return an HttpClientRequest or null.
- when null is returned, the original response is processed by the original request response handler
- when a new Future is returned, the client will send this new request
The new request will get a copy of the previous request headers unless headers are set. In this case, the client assumes that the redirect handler exclusively managers the headers of the new request.
The handler must return a Future unsent so the client can further configure it and send it.
Parameters
- handler: (arg: HttpClientResponse) => PromiseLike<RequestOptions>
  - - (arg: HttpClientResponse): PromiseLike<RequestOptions>
    - Parameters
      - arg: HttpClientResponse
      Returns PromiseLike<RequestOptions>
Returns HttpClient

request

request(options: RequestOptions): PromiseLike<HttpClientRequest>
request(options: RequestOptions, handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>): void
request(method: HttpMethod, port: number, host: string, requestURI: string): PromiseLike<HttpClientRequest>
request(method: HttpMethod, port: number, host: string, requestURI: string, handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>): void
request(method: HttpMethod, host: string, requestURI: string): PromiseLike<HttpClientRequest>
request(method: HttpMethod, host: string, requestURI: string, handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>): void
request(method: HttpMethod, requestURI: string): PromiseLike<HttpClientRequest>
request(method: HttpMethod, requestURI: string, handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3129
Create an HTTP request to send to the server. The handler is called when the request is ready to be sent.

Parameters
- options: RequestOptions
Returns PromiseLike<HttpClientRequest>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3135
Create an HTTP request to send to the server. The handler is called when the request is ready to be sent.

Parameters
- options: RequestOptions
- handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3141
Create an HTTP request to send to the server at the host and port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- port: number
- host: string
- requestURI: string
Returns PromiseLike<HttpClientRequest>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3147
Create an HTTP request to send to the server at the host and port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- port: number
- host: string
- requestURI: string
- handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3153
Create an HTTP request to send to the server at the host and default port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- host: string
- requestURI: string
Returns PromiseLike<HttpClientRequest>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3159
Create an HTTP request to send to the server at the host and default port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- host: string
- requestURI: string
- handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3165
Create an HTTP request to send to the server at the default host and port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- requestURI: string
Returns PromiseLike<HttpClientRequest>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3171
Create an HTTP request to send to the server at the default host and port. The handler is called when the request is ready to be sent.

Parameters
- method: HttpMethod
- requestURI: string
- handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>
Returns void

updateSSLOptions

updateSSLOptions(options: SSLOptions): PromiseLike<void>
updateSSLOptions(options: SSLOptions, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3229
Like {@link HttpClient#updateSSLOptions} but supplying a handler that will be called when the update happened (or has failed).

Parameters
- options: SSLOptions
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3235
Like {@link HttpClient#updateSSLOptions} but supplying a handler that will be called when the update happened (or has failed).

Parameters
- options: SSLOptions
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

webSocket

webSocket(port: number, host: string, requestURI: string): PromiseLike<WebSocket>
webSocket(port: number, host: string, requestURI: string, handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>): void
webSocket(host: string, requestURI: string): PromiseLike<WebSocket>
webSocket(host: string, requestURI: string, handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>): void
webSocket(requestURI: string): PromiseLike<WebSocket>
webSocket(requestURI: string, handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>): void
webSocket(options: WebSocketConnectOptions): PromiseLike<WebSocket>
webSocket(options: WebSocketConnectOptions, handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3176
Connect a WebSocket to the specified port, host and relative request URI

Parameters
- port: number
- host: string
- requestURI: string
Returns PromiseLike<WebSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3181
Connect a WebSocket to the specified port, host and relative request URI

Parameters
- port: number
- host: string
- requestURI: string
- handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3186
Connect a WebSocket to the host and relative request URI and default port

Parameters
- host: string
- requestURI: string
Returns PromiseLike<WebSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3191
Connect a WebSocket to the host and relative request URI and default port

Parameters
- host: string
- requestURI: string
- handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3196
Connect a WebSocket at the relative request URI using the default host and port

Parameters
- requestURI: string
Returns PromiseLike<WebSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3201
Connect a WebSocket at the relative request URI using the default host and port

Parameters
- requestURI: string
- handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>
Returns void
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3206
Connect a WebSocket with the specified options.

Parameters
- options: WebSocketConnectOptions
Returns PromiseLike<WebSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3211
Connect a WebSocket with the specified options.

Parameters
- options: WebSocketConnectOptions
- handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>
Returns void

webSocketAbs

webSocketAbs(url: string, headers: MultiMap, version: WebsocketVersion, subProtocols: string): PromiseLike<WebSocket>
webSocketAbs(url: string, headers: MultiMap, version: WebsocketVersion, subProtocols: string, handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3217
Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified WebSocket sub protocols.

Parameters
- url: string
- headers: MultiMap
- version: WebsocketVersion
- subProtocols: string
Returns PromiseLike<WebSocket>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3223
Connect a WebSocket with the specified absolute url, with the specified headers, using the specified version of WebSockets, and the specified WebSocket sub protocols.

Parameters
- url: string
- headers: MultiMap
- version: WebsocketVersion
- subProtocols: string
- handler: ((res: AsyncResult<WebSocket>) => void) | Handler<AsyncResult<WebSocket>>
Returns void

Hierarchy

Implements

Index

Methods

Methods

close

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

connectionHandler

Parameters

handler: ((res: HttpConnection) => void) | Handler<HttpConnection>

Returns HttpClient

isMetricsEnabled

Returns boolean

redirectHandler

Parameters

handler: (arg: HttpClientResponse) => PromiseLike<RequestOptions>

Parameters

arg: HttpClientResponse

Returns PromiseLike<RequestOptions>

Returns HttpClient

request

Parameters

options: RequestOptions

Returns PromiseLike<HttpClientRequest>

Parameters

options: RequestOptions

handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>

Returns void

Parameters

method: HttpMethod

port: number

host: string

requestURI: string

Returns PromiseLike<HttpClientRequest>

Parameters

method: HttpMethod

port: number

host: string

requestURI: string

handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>

Returns void

Parameters

method: HttpMethod

host: string

requestURI: string

Returns PromiseLike<HttpClientRequest>

Parameters

method: HttpMethod

host: string

requestURI: string

handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>

Returns void

Parameters

method: HttpMethod

requestURI: string

Returns PromiseLike<HttpClientRequest>

Parameters

method: HttpMethod

requestURI: string

handler: ((res: AsyncResult<HttpClientRequest>) => void) | Handler<AsyncResult<HttpClientRequest>>

Returns void

updateSSLOptions

Parameters

options: SSLOptions

Returns PromiseLike<void>

Parameters

options: SSLOptions

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

webSocket

Parameters

port: number

host: string

requestURI: string

Returns PromiseLike<WebSocket>

Parameters

port: number