Class HttpClientConnection

java.lang.Object

io.vertx.reactivex.core.http.HttpConnection

io.vertx.reactivex.core.http.HttpClientConnection

All Implemented Interfaces:

io.vertx.lang.rx.RxDelegate, HttpClient

public class HttpClientConnection
extends HttpConnection
implements io.vertx.lang.rx.RxDelegate, HttpClient

Represents an HTTP client connection.

You can use this connection to create requests to the connected server.

Depending on the nature of the connection, requests might just be sent to the server or might be queued until a connection request is available.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final io.vertx.lang.rx.TypeArg<HttpClientConnection>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
HttpClientConnection(HttpClientConnection delegate)
HttpClientConnection(Object delegate)

Method Summary

Modifier and Type	Method	Description
long	activeStreams()
Future<Void>	close()	Close immediately (shutdown(0, TimeUnit.SECONDS).
boolean	equals(Object o)
HttpClientConnection	getDelegate()
int	hashCode()
long	maxActiveStreams()
static HttpClientConnection	newInstance(HttpClientConnection arg)
Future<HttpClientRequest>	request()	Create an HTTP request to send to the server with the default host and port of the client.
Future<HttpClientRequest>	request(HttpMethod method, int port, String host, String requestURI)	Create an HTTP request to send to the server at the host and port.
Future<HttpClientRequest>	request(HttpMethod method, String requestURI)	Create an HTTP request to send to the server at the default host and port.
Future<HttpClientRequest>	request(HttpMethod method, String host, String requestURI)	Create an HTTP request to send to the server at the host and default port.
Future<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)	Calls HttpConnection.shutdown()
Completable	rxShutdown(Duration timeout)	Initiate the client shutdown sequence.
Future<Void>	shutdown()	Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
Future<Void>	shutdown(long timeout, TimeUnit unit)	Calls HttpConnection.shutdown()
Future<Void>	shutdown(Duration timeout)	Initiate the client shutdown sequence.
String	toString()

Methods inherited from class HttpConnection

closeHandler, exceptionHandler, getWindowSize, goAway, goAway, goAway, goAwayHandler, indicatedServerName, isSsl, localAddress, localAddress, newInstance, ping, pingHandler, protocolVersion, remoteAddress, remoteAddress, remoteSettings, remoteSettingsHandler, rxPing, rxUpdateSettings, settings, setWindowSize, shutdownHandler, sslSession, updateSettings

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

__TYPE_ARG

public static final io.vertx.lang.rx.TypeArg<HttpClientConnection> __TYPE_ARG

Constructor Details

HttpClientConnection

public HttpClientConnection(HttpClientConnection delegate)

HttpClientConnection

public HttpClientConnection(Object delegate)

Method Details

toString

public String toString()

Overrides:

toString in class HttpConnection

equals

public boolean equals(Object o)

Overrides:

equals in class HttpConnection

hashCode

public int hashCode()

Overrides:

hashCode in class HttpConnection

getDelegate

public HttpClientConnection getDelegate()

Specified by:

getDelegate in interface HttpClient

Specified by:

getDelegate in interface io.vertx.lang.rx.RxDelegate

Overrides:

getDelegate in class HttpConnection

request

public Future<HttpClientRequest> request()

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

Specified by:

request in interface HttpClient

Returns:

a future notified when the request is ready to be sent

rxRequest

public Single<HttpClientRequest> rxRequest()

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

Specified by:

rxRequest in interface HttpClient

Returns:

a future notified when the request is ready to be sent

request

public Future<HttpClientRequest> request(RequestOptions options)

Create an HTTP request to send to the server.

Specified by:

request in interface HttpClient

Parameters:

options - the request options

Returns:

a future notified when the request is ready to be sent

rxRequest

public Single<HttpClientRequest> rxRequest(RequestOptions options)

Create an HTTP request to send to the server.

Specified by:

rxRequest in interface HttpClient

Parameters:

options - the request options

Returns:

a future notified when the request is ready to be sent

request

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

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

Specified by:

request in interface HttpClient

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

public 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.

Specified by:

rxRequest in interface HttpClient

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

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

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

Specified by:

request in interface HttpClient

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

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

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

Specified by:

rxRequest in interface HttpClient

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

public Future<HttpClientRequest> request(HttpMethod method,
 String requestURI)

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

Specified by:

request in interface HttpClient

Parameters:

method - the HTTP method

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

rxRequest

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

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

Specified by:

rxRequest in interface HttpClient

Parameters:

method - the HTTP method

requestURI - the relative URI

Returns:

a future notified when the request is ready to be sent

activeStreams

public long activeStreams()

Returns:

the number of active request/response (streams)

maxActiveStreams

public long maxActiveStreams()

Returns:

the max number of concurrent active streams this connection can handle

shutdown

public Future<Void> shutdown()

Description copied from class: HttpConnection

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

Specified by:

shutdown in interface HttpClient

Overrides:

shutdown in class HttpConnection

Returns:

a future completed when shutdown has completed

rxShutdown

public Completable rxShutdown()

Description copied from class: HttpConnection

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

Specified by:

rxShutdown in interface HttpClient

Overrides:

rxShutdown in class HttpConnection

Returns:

a future completed when shutdown has completed

shutdown

public Future<Void> shutdown(long timeout,
 TimeUnit unit)

Description copied from class: HttpConnection

Calls HttpConnection.shutdown()

Specified by:

shutdown in interface HttpClient

Overrides:

shutdown in class HttpConnection

Parameters:

timeout -

unit -

Returns:

rxShutdown

public Completable rxShutdown(long timeout,
 TimeUnit unit)

Description copied from class: HttpConnection

Calls HttpConnection.shutdown()

Specified by:

rxShutdown in interface HttpClient

Overrides:

rxShutdown in class HttpConnection

Parameters:

timeout -

unit -

Returns:

close

public Future<Void> close()

Description copied from class: HttpConnection

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

Specified by:

close in interface HttpClient

Overrides:

close in class HttpConnection

Returns:

a future notified when the client is closed

rxClose

public Completable rxClose()

Description copied from class: HttpConnection

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

Specified by:

rxClose in interface HttpClient

Overrides:

rxClose in class HttpConnection

Returns:

a future notified when the client is closed

shutdown

public Future<Void> shutdown(Duration timeout)

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

Overrides:

shutdown in class HttpConnection

Parameters:

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

Returns:

a future notified when the client is closed

rxShutdown

public Completable rxShutdown(Duration timeout)

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

Overrides:

rxShutdown in class HttpConnection

Parameters:

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

Returns:

a future notified when the client is closed

newInstance

public static HttpClientConnection newInstance(HttpClientConnection arg)