Package io.vertx.rxjava3.core.http

Interface HttpClient

All Known Implementing Classes:

HttpClientAgent, HttpClientConnection

public interface HttpClient

The API to interacts with an HTTP server.

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Method Summary

Modifier and Type	Method	Description
Completable	close()	Close immediately (shutdown(0, TimeUnit.SECONDS).
HttpClient	getDelegate()
static HttpClient	newInstance(HttpClient arg)
Single<HttpClientRequest>	request()	Create an HTTP request to send to the server with the default host and port of the client.
Single<HttpClientRequest>	request(HttpMethod method, int port, String host, String requestURI)	Create an HTTP request to send to the server at the host and port.
Single<HttpClientRequest>	request(HttpMethod method, String requestURI)	Create an HTTP request to send to the server at the default host and port.
Single<HttpClientRequest>	request(HttpMethod method, String host, String requestURI)	Create an HTTP request to send to the server at the host and default port.
Single<HttpClientRequest>	request(RequestOptions options)	Create an HTTP request to send to the server.
Completable	rxClose()	Close immediately (shutdown(0, TimeUnit.SECONDS).
Single<HttpClientRequest>	rxRequest()	Create an HTTP request to send to the server with the default host and port of the client.
Single<HttpClientRequest>	rxRequest(HttpMethod method, int port, String host, String requestURI)	Create an HTTP request to send to the server at the host and port.
Single<HttpClientRequest>	rxRequest(HttpMethod method, String requestURI)	Create an HTTP request to send to the server at the default host and port.
Single<HttpClientRequest>	rxRequest(HttpMethod method, String host, String requestURI)	Create an HTTP request to send to the server at the host and default port.
Single<HttpClientRequest>	rxRequest(RequestOptions options)	Create an HTTP request to send to the server.
Completable	rxShutdown()	Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
Completable	rxShutdown(long timeout, TimeUnit unit)	Initiate the client shutdown sequence.
Completable	shutdown()	Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
Completable	shutdown(long timeout, TimeUnit unit)	Initiate the client shutdown sequence.

Method Detail

getDelegate

HttpClient getDelegate()

request

Single<HttpClientRequest> request()

Create an HTTP request to send to the server with the default host and port of the client.

Returns:

a future notified when the request is ready to be sent

rxRequest

Single<HttpClientRequest> rxRequest()

Create an HTTP request to send to the server with the default host and port of the client.

Returns:

a future notified when the request is ready to be sent

request

Single<HttpClientRequest> request(RequestOptions options)

Create an HTTP request to send to the server.

Parameters:

options - the request options

Returns:

a future notified when the request is ready to be sent

rxRequest

Single<HttpClientRequest> rxRequest(RequestOptions options)

Create an HTTP request to send to the server.

Parameters:

options - the request options

Returns:

a future notified when the request is ready to be sent

request

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

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

Parameters:

method - the HTTP method

port - the port

host - the host

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

rxRequest

Single<HttpClientRequest> rxRequest(HttpMethod method,
                                    int port,
                                    String host,
                                    String requestURI)

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

Parameters:

method - the HTTP method

port - the port

host - the host

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

request

Single<HttpClientRequest> request(HttpMethod method,
                                  String host,
                                  String requestURI)

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

Parameters:

method - the HTTP method

host - the host

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

rxRequest

Single<HttpClientRequest> rxRequest(HttpMethod method,
                                    String host,
                                    String requestURI)

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

Parameters:

method - the HTTP method

host - the host

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

request

Single<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:

a future notified when the request is ready to be sent

rxRequest

Single<HttpClientRequest> rxRequest(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:

a future notified when the request is ready to be sent

shutdown

Completable shutdown()

Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).

Returns:

a future completed when shutdown has completed

rxShutdown

Completable rxShutdown()

Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).

Returns:

a future completed when shutdown has completed

close

Completable close()

Close immediately (shutdown(0, TimeUnit.SECONDS).

Returns:

a future notified when the client is closed

rxClose

Completable rxClose()

Close immediately (shutdown(0, TimeUnit.SECONDS).

Returns:

a future notified when the client is closed

shutdown

Completable shutdown(long timeout,
                     TimeUnit unit)

Initiate the client shutdown sequence.

Connections are taken out of service and closed when all inflight requests are processed, client connection are immediately removed from the pool. When all connections are closed the client is closed. When the timeout expires, all unclosed connections are immediately closed.

• HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
• HTTP/1.x client connection will be closed after the current response is received

Parameters:

timeout - the amount of time after which all resources are forcibly closed

unit - the of the timeout

Returns:

a future notified when the client is closed

rxShutdown

Completable rxShutdown(long timeout,
                       TimeUnit unit)

Initiate the client shutdown sequence.

Connections are taken out of service and closed when all inflight requests are processed, client connection are immediately removed from the pool. When all connections are closed the client is closed. When the timeout expires, all unclosed connections are immediately closed.

• HTTP/2 connections will send a go away frame immediately to signal the other side the connection will close
• HTTP/1.x client connection will be closed after the current response is received

Parameters:

timeout - the amount of time after which all resources are forcibly closed

unit - the of the timeout

Returns:

a future notified when the client is closed

newInstance

static HttpClient newInstance(HttpClient arg)