Vert.x 4.5.13 · io.vertx.core.http.impl.HttpClientRequestBase

Modifier and Type	Field and Description
protected final ContextInternal	context
private long	currentTimeoutMs
private long	currentTimeoutTimerId
private String	host
private long	lastDataReceived
private HttpMethod	method
private String	path
private int	port
private Handler<HttpClientRequest>	pushHandler
private String	query
private Throwable	reset
private final PromiseInternal<HttpClientResponse>	responsePromise
protected final SocketAddress	server
protected final boolean	ssl
protected final HttpClientStream	stream
private String	uri

Access	Constructor and Description
pack-priv	HttpClientRequestBase(HttpClientStream stream, PromiseInternal<HttpClientResponse> responsePromise, HttpMethod method, SocketAddress server, String host, int port, String uri)

Method Summary

Modifier and Type	Method and Description
public String	absoluteURI() Implements io.vertx.core.http.HttpClientRequest.absoluteURI.
protected String	authority()
public synchronized HttpClientRequest	authority(HostAndPort override the request authority authority) Implements io.vertx.core.http.HttpClientRequest.authority. Override the request authority, when using HTTP/1.x this overrides the request `host` header, when using HTTP/2 this sets the `authority` pseudo header.
private synchronized long	cancelTimeout()
pack-priv synchronized void	dataReceived()
pack-priv void	fail(Throwable t)
public String	getHost() Implements io.vertx.core.http.HttpClientRequest.getHost.
public synchronized HttpMethod	getMethod() Implements io.vertx.core.http.HttpClientRequest.getMethod. The HTTP method for the request.
public int	getPort() Implements io.vertx.core.http.HttpClientRequest.getPort.
public synchronized String	getURI() Implements io.vertx.core.http.HttpClientRequest.getURI.
pack-priv void	handleException(Throwable t)
pack-priv void	handlePush(HttpClientPush push)
pack-priv void	handleResponse(HttpClientResponse resp)
pack-priv abstract void	handleResponse(Promise<HttpClientResponse> promise, HttpClientResponse resp, long timeoutMs)
private void	handleTimeout(long timeoutMs)
protected Throwable	mapException(Throwable t)
public String	path() Implements io.vertx.core.http.HttpClientRequest.path.
pack-priv synchronized Handler<HttpClientRequest>	pushHandler()
public synchronized HttpClientRequest	pushHandler(Handler<HttpClientRequest> the handler handler) Implements io.vertx.core.http.HttpClientRequest.pushHandler. Set a push handler for this request.
public String	query() Implements io.vertx.core.http.HttpClientRequest.query.
public boolean	reset(long the error code code) Implements io.vertx.core.http.HttpClientRequest.reset. Reset this request: for HTTP/2, this performs send an HTTP/2 reset frame with the specified error `code` for HTTP/1.x, this closes the connection when the current request is inflight
public boolean	reset(long the error code code, Throwable an optional cause that can be attached to the error code cause) Implements io.vertx.core.http.HttpClientRequest.reset. Reset this request: for HTTP/2, send an HTTP/2 reset frame with the specified error `code` for HTTP/1.x, close the connection when the current request is inflight
private boolean	reset(Throwable cause)
public HttpClientRequest	response(Handler<AsyncResult<HttpClientResponse>> the completion handler handler) Implements io.vertx.core.http.HttpClientRequest.response. Set a callback for the associated `HttpClientResponse`.
public Future<HttpClientResponse>	response() Implements io.vertx.core.http.HttpClientRequest.response.
public synchronized HttpClientRequest	setHost(String the host part of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header host) Implements io.vertx.core.http.HttpClientRequest.setHost. Set the host value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header The initial value is the same as the server socket address host.
public synchronized HttpClientRequest	setMethod(HttpMethod the HTTP method method) Implements io.vertx.core.http.HttpClientRequest.setMethod. Set the HTTP method for this request.
public synchronized HttpClientRequest	setPort(int the port part of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header port) Implements io.vertx.core.http.HttpClientRequest.setPort. Set the port value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header Keep in mind that this won't change the actual server socket address for this request.
public synchronized HttpClientRequest	setTimeout(long timeout) Implements io.vertx.core.http.HttpClientRequest.setTimeout. Like `idleTimeout(long)` but with a confusing name (hence the deprecation).
public synchronized HttpClientRequest	setURI(String the request uri uri) Implements io.vertx.core.http.HttpClientRequest.setURI. Set the request uri.
public int	streamId() Overrides default io.vertx.core.http.HttpClientRequest.streamId.
pack-priv static NoStackTraceTimeoutException	timeoutEx(long timeoutMs, HttpMethod method, SocketAddress server, String uri)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

context	back to summary
protected final ContextInternal context

currentTimeoutMs	back to summary
private long currentTimeoutMs

currentTimeoutTimerId	back to summary
private long currentTimeoutTimerId

host	back to summary
private String host

lastDataReceived	back to summary
private long lastDataReceived

method	back to summary
private HttpMethod method

path	back to summary
private String path

port	back to summary
private int port

pushHandler	back to summary
private Handler<HttpClientRequest> pushHandler

query	back to summary
private String query

reset	back to summary
private Throwable reset

responsePromise	back to summary
private final PromiseInternal<HttpClientResponse> responsePromise

server	back to summary
protected final SocketAddress server

ssl	back to summary
protected final boolean ssl

stream	back to summary
protected final HttpClientStream stream

uri	back to summary
private String uri

HttpClientRequestBase	back to summary
pack-priv HttpClientRequestBase(HttpClientStream stream, PromiseInternal<HttpClientResponse> responsePromise, HttpMethod method, SocketAddress server, String host, int port, String uri)

Method Detail

absoluteURI	back to summary
public String absoluteURI() Implements io.vertx.core.http.HttpClientRequest.absoluteURI. Returns:String Doc from io.vertx.core.http.HttpClientRequest.absoluteURI. the absolute URI corresponding to the HTTP request Annotations @Override

absoluteURI

back to summary

public String absoluteURI()

Implements io.vertx.core.http.HttpClientRequest.absoluteURI.

Returns:String

Doc from io.vertx.core.http.HttpClientRequest.absoluteURI.

the absolute URI corresponding to the HTTP request

Annotations

@Override

authority	back to summary
protected String authority()

authority back to summary

authority	back to summary
public synchronized HttpClientRequest authority(HostAndPort authority) Implements io.vertx.core.http.HttpClientRequest.authority. Doc from io.vertx.core.http.HttpClientRequest.authority. Override the request authority, when using HTTP/1.x this overrides the request `host` header, when using HTTP/2 this sets the `authority` pseudo header. When the port is a negative value, the default scheme port will be used. The default request authority is the server host and port when connecting to the server. Parameters authority:HostAndPort override the request authority Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

public synchronized HttpClientRequest authority(HostAndPort authority)

Implements io.vertx.core.http.HttpClientRequest.authority.

Doc from io.vertx.core.http.HttpClientRequest.authority.

Override the request authority, when using HTTP/1.x this overrides the request host header, when using HTTP/2 this sets the authority pseudo header. When the port is a negative value, the default scheme port will be used.

The default request authority is the server host and port when connecting to the server.

Parameters

authority:HostAndPort: override the request authority

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

cancelTimeout	back to summary
private synchronized long cancelTimeout()

dataReceived	back to summary
pack-priv synchronized void dataReceived()

fail	back to summary
pack-priv void fail(Throwable t)

getHost back to summary

getHost	back to summary
public String getHost() Implements io.vertx.core.http.HttpClientRequest.getHost. Returns:String Doc from io.vertx.core.http.HttpClientRequest.getHost. the host value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header

public String getHost()

Implements io.vertx.core.http.HttpClientRequest.getHost.

Returns:String

Doc from io.vertx.core.http.HttpClientRequest.getHost.

the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

getMethod	back to summary
public synchronized HttpMethod getMethod() Implements io.vertx.core.http.HttpClientRequest.getMethod. Doc from io.vertx.core.http.HttpClientRequest.getMethod. The HTTP method for the request. Annotations @Override

getMethod

back to summary

public synchronized HttpMethod getMethod()

Implements io.vertx.core.http.HttpClientRequest.getMethod.

Doc from io.vertx.core.http.HttpClientRequest.getMethod.

The HTTP method for the request.

Annotations

@Override

getPort back to summary

getPort	back to summary
public int getPort() Implements io.vertx.core.http.HttpClientRequest.getPort. Returns:int Doc from io.vertx.core.http.HttpClientRequest.getPort. the port value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header Annotations @Override

public int getPort()

Implements io.vertx.core.http.HttpClientRequest.getPort.

Returns:int

Doc from io.vertx.core.http.HttpClientRequest.getPort.

the port value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

Annotations

@Override

getURI	back to summary
public synchronized String getURI() Implements io.vertx.core.http.HttpClientRequest.getURI. Returns:String Doc from io.vertx.core.http.HttpClientRequest.getURI. The URI of the request.

getURI

back to summary

public synchronized String getURI()

Implements io.vertx.core.http.HttpClientRequest.getURI.

Returns:String

Doc from io.vertx.core.http.HttpClientRequest.getURI.

The URI of the request.

handleException	back to summary
pack-priv void handleException(Throwable t)

handlePush	back to summary
pack-priv void handlePush(HttpClientPush push)

handleResponse	back to summary
pack-priv void handleResponse(HttpClientResponse resp)

handleResponse	back to summary
pack-priv abstract void handleResponse(Promise<HttpClientResponse> promise, HttpClientResponse resp, long timeoutMs)

handleTimeout	back to summary
private void handleTimeout(long timeoutMs)

mapException	back to summary
protected Throwable mapException(Throwable t)

path	back to summary
public String path() Implements io.vertx.core.http.HttpClientRequest.path. Returns:String Doc from io.vertx.core.http.HttpClientRequest.path. The path part of the uri. For example /somepath/somemorepath/someresource.foo

path

back to summary

public String path()

Implements io.vertx.core.http.HttpClientRequest.path.

Returns:String

Doc from io.vertx.core.http.HttpClientRequest.path.

The path part of the uri. For example /somepath/somemorepath/someresource.foo

pushHandler	back to summary
pack-priv synchronized Handler<HttpClientRequest> pushHandler()

pushHandler back to summary

pushHandler	back to summary
public synchronized HttpClientRequest pushHandler(Handler<HttpClientRequest> handler) Implements io.vertx.core.http.HttpClientRequest.pushHandler. Doc from io.vertx.core.http.HttpClientRequest.pushHandler. Set a push handler for this request. The handler is called when the client receives a push promise from the server. The handler can be called multiple times, for each push promise. The handler is called with a read-only `HttpClientRequest`, the following methods can be called: `HttpClientRequest#getMethod()` `HttpClientRequest#getURI()` `HttpClientRequest#headers()` In addition the handler should call the `HttpClientRequest#response(Handler)` method to set an handler to process the response. Parameters handler:Handler<HttpClientRequest> the handler Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

public synchronized HttpClientRequest pushHandler(Handler<HttpClientRequest> handler)

Implements io.vertx.core.http.HttpClientRequest.pushHandler.

Doc from io.vertx.core.http.HttpClientRequest.pushHandler.

Set a push handler for this request.

The handler is called when the client receives a push promise from the server. The handler can be called multiple times, for each push promise.

The handler is called with a read-only HttpClientRequest, the following methods can be called:

In addition the handler should call the HttpClientRequest#response(Handler) method to set an handler to process the response.

Parameters

handler:Handler<HttpClientRequest>: the handler

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

query	back to summary
public String query() Implements io.vertx.core.http.HttpClientRequest.query. Returns:String Doc from io.vertx.core.http.HttpClientRequest.query. the query part of the uri. For example someparam=32&someotherparam=x

query

back to summary

public String query()

Implements io.vertx.core.http.HttpClientRequest.query.

Returns:String

Doc from io.vertx.core.http.HttpClientRequest.query.

the query part of the uri. For example someparam=32&someotherparam=x

reset back to summary

reset	back to summary
public boolean reset(long code) Implements io.vertx.core.http.HttpClientRequest.reset. Doc from io.vertx.core.http.HttpClientRequest.reset. Reset this request: for HTTP/2, this performs send an HTTP/2 reset frame with the specified error `code` for HTTP/1.x, this closes the connection when the current request is inflight When the request has not yet been sent, the request will be aborted and false is returned as indicator. Parameters code:long the error code Returns:boolean `true` when reset has been performed Annotations @Override

public boolean reset(long code)

Implements io.vertx.core.http.HttpClientRequest.reset.

Doc from io.vertx.core.http.HttpClientRequest.reset.

Reset this request:

for HTTP/2, this performs send an HTTP/2 reset frame with the specified error code
for HTTP/1.x, this closes the connection when the current request is inflight

When the request has not yet been sent, the request will be aborted and false is returned as indicator.

Parameters

code:long: the error code

Returns:boolean

true when reset has been performed

Annotations

@Override

reset back to summary

reset	back to summary
public boolean reset(long code, Throwable cause) Implements io.vertx.core.http.HttpClientRequest.reset. Doc from io.vertx.core.http.HttpClientRequest.reset. Reset this request: for HTTP/2, send an HTTP/2 reset frame with the specified error `code` for HTTP/1.x, close the connection when the current request is inflight When the request has not yet been sent, the request will be aborted and `false` is returned as indicator. Parameters code:long the error code cause:Throwable an optional cause that can be attached to the error code Returns:boolean true when reset has been performed Annotations @Override

public boolean reset(long code, Throwable cause)

Implements io.vertx.core.http.HttpClientRequest.reset.

Doc from io.vertx.core.http.HttpClientRequest.reset.

Reset this request:

for HTTP/2, send an HTTP/2 reset frame with the specified error code
for HTTP/1.x, close the connection when the current request is inflight

When the request has not yet been sent, the request will be aborted and false is returned as indicator.

Parameters

code:long: the error code
cause:Throwable: an optional cause that can be attached to the error code

Returns:boolean

true when reset has been performed

Annotations

@Override

reset	back to summary
private boolean reset(Throwable cause)

response back to summary

response	back to summary
public HttpClientRequest response(Handler<AsyncResult<HttpClientResponse>> handler) Implements io.vertx.core.http.HttpClientRequest.response. Doc from io.vertx.core.http.HttpClientRequest.response. Set a callback for the associated `HttpClientResponse`. This method does not modify the current request being sent. Parameters handler:Handler<AsyncResult<HttpClientResponse>> the completion handler Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

public HttpClientRequest response(Handler<AsyncResult<HttpClientResponse>> handler)

Implements io.vertx.core.http.HttpClientRequest.response.

Doc from io.vertx.core.http.HttpClientRequest.response.

Set a callback for the associated HttpClientResponse.

This method does not modify the current request being sent.

Parameters

handler:Handler<AsyncResult<HttpClientResponse>>: the completion handler

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

response back to summary

response	back to summary
public Future<HttpClientResponse> response() Implements io.vertx.core.http.HttpClientRequest.response. Returns:Future<HttpClientResponse> Doc from io.vertx.core.http.HttpClientRequest.response. a future of the `HttpClientResponse`, see `response(Handler)` Annotations @Override

public Future<HttpClientResponse> response()

Implements io.vertx.core.http.HttpClientRequest.response.

Returns:Future<HttpClientResponse>

Doc from io.vertx.core.http.HttpClientRequest.response.

a future of the HttpClientResponse, see response(Handler)

Annotations

@Override

setHost back to summary

setHost	back to summary
public synchronized HttpClientRequest setHost(String host) Implements io.vertx.core.http.HttpClientRequest.setHost. Doc from io.vertx.core.http.HttpClientRequest.setHost. Set the host value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header The initial value is the same as the server socket address host. Keep in mind that changing this value won't change the actual server socket address for this request. Parameters host:String the host part of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

public synchronized HttpClientRequest setHost(String host)

Implements io.vertx.core.http.HttpClientRequest.setHost.

Doc from io.vertx.core.http.HttpClientRequest.setHost.

Set the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

The initial value is the same as the server socket address host.

Keep in mind that changing this value won't change the actual server socket address for this request.

Parameters

host:String: the host part of the HTTP/1.1 host header or HTTP/2 authority pseudo header

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

setMethod	back to summary
public synchronized HttpClientRequest setMethod(HttpMethod method) Implements io.vertx.core.http.HttpClientRequest.setMethod. Doc from io.vertx.core.http.HttpClientRequest.setMethod. Set the HTTP method for this request. Parameters method:HttpMethod the HTTP method Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

setMethod

back to summary

public synchronized HttpClientRequest setMethod(HttpMethod method)

Implements io.vertx.core.http.HttpClientRequest.setMethod.

Doc from io.vertx.core.http.HttpClientRequest.setMethod.

Set the HTTP method for this request.

Parameters

method:HttpMethod: the HTTP method

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

setPort back to summary

setPort	back to summary
public synchronized HttpClientRequest setPort(int port) Implements io.vertx.core.http.HttpClientRequest.setPort. Doc from io.vertx.core.http.HttpClientRequest.setPort. Set the port value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header Keep in mind that this won't change the actual server socket address for this request. The initial value is the same than the server socket address port. Parameters port:int the port part of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

public synchronized HttpClientRequest setPort(int port)

Implements io.vertx.core.http.HttpClientRequest.setPort.

Doc from io.vertx.core.http.HttpClientRequest.setPort.

Set the port value of the HTTP/1.1 host header or HTTP/2 authority pseudo header

Keep in mind that this won't change the actual server socket address for this request.

The initial value is the same than the server socket address port.

Parameters

port:int: the port part of the HTTP/1.1 host header or HTTP/2 authority pseudo header

Returns:HttpClientRequest

a reference to this, so the API can be used fluently

Annotations

@Override

setTimeout back to summary

setTimeout	back to summary
public synchronized HttpClientRequest setTimeout(long timeout) Implements io.vertx.core.http.HttpClientRequest.setTimeout. Doc from io.vertx.core.http.HttpClientRequest.setTimeout. Like `idleTimeout(long)` but with a confusing name (hence the deprecation). Annotations @Override

public synchronized HttpClientRequest setTimeout(long timeout)

Implements io.vertx.core.http.HttpClientRequest.setTimeout.

Doc from io.vertx.core.http.HttpClientRequest.setTimeout.

Like idleTimeout(long) but with a confusing name (hence the deprecation).

Annotations

@Override

setURI	back to summary
public synchronized HttpClientRequest setURI(String uri) Implements io.vertx.core.http.HttpClientRequest.setURI. Doc from io.vertx.core.http.HttpClientRequest.setURI. Set the request uri. Parameters uri:String the request uri Returns:HttpClientRequest a reference to this, so the API can be used fluently Annotations @Override

setURI

back to summary

public synchronized HttpClientRequest setURI(String uri)

Implements io.vertx.core.http.HttpClientRequest.setURI.

Doc from io.vertx.core.http.HttpClientRequest.setURI.

Set the request uri.

Parameters