HttpClientRequestBase (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.core.http.impl.HttpClientRequestBase

All Implemented Interfaces:

HttpClientRequest, StreamBase, WriteStream<Buffer>

Direct Known Subclasses:

HttpClientRequestImpl
```
public abstract class HttpClientRequestBase
extends Object
implements HttpClientRequest
```
Author:

Julien Viet

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpClientImpl`	`client`
`protected ContextInternal`	`context`
`protected SocketAddress`	`server`
`protected boolean`	`ssl`
`protected HttpClientStream`	`stream`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`absoluteURI()`
`protected String`	`authority()`
`String`	`getHost()`
`HttpMethod`	`getMethod()` The HTTP method for the request.
`int`	`getPort()`
`String`	`getURI()`
`String`	`path()`
`HttpClientRequest`	`pushHandler(Handler<HttpClientRequest> handler)` Set a push handler for this request. The handler is called when the client receives a push promise from the server.
`String`	`query()`
`boolean`	`reset(long code)` 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.
`boolean`	`reset(long code, Throwable cause)` 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.
`Future<HttpClientResponse>`	`response()`
`HttpClientRequest`	`response(Handler<AsyncResult<HttpClientResponse>> handler)` Set a callback for the associated `HttpClientResponse`.
`HttpClientRequest`	`setHost(String host)` Set the host value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header
`HttpClientRequest`	`setMethod(HttpMethod method)` Set the HTTP method for this request.
`HttpClientRequest`	`setPort(int port)` Set the port value of the HTTP/1.1 `host` header or HTTP/2 `authority` pseudo header
`HttpClientRequest`	`setTimeout(long timeoutMs)` Set's the amount of time after which if the request does not return any data within the timeout period an `TimeoutException` will be passed to the exception handler (if provided) and the request will be closed.
`HttpClientRequest`	`setURI(String uri)` Set the request uri.
`int`	`streamId()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vertx.core.http.HttpClientRequest
connect, connect, connection, continueHandler, drainHandler, end, end, end, end, end, end, end, end, exceptionHandler, getStreamPriority, headers, isChunked, putHeader, putHeader, putHeader, putHeader, reset, send, send, send, send, send, send, send, send, sendHead, sendHead, setChunked, setFollowRedirects, setMaxRedirects, setStreamPriority, setWriteQueueMaxSize, version, write, write, write, write, writeCustomFrame, writeCustomFrame

Methods inherited from interface io.vertx.core.streams.WriteStream
write, write, writeQueueFull

- Field Detail
  - client
```
protected final HttpClientImpl client
```
  - context
```
protected final ContextInternal context
```
  - stream
```
protected final HttpClientStream stream
```
  - server
```
protected final SocketAddress server
```
  - ssl
```
protected final boolean ssl
```
- Method Detail
  - authority
```
protected String authority()
```
  - streamId
```
public int streamId()
```
    Specified by:
    
    streamId in interface HttpClientRequest
    
    Returns:
    
    the id of the stream of this response, -1 when it is not yet determined, i.e the request has not been yet sent or it is not supported HTTP/1.x
  - absoluteURI
```
public String absoluteURI()
```
    Specified by:
    
    absoluteURI in interface HttpClientRequest
    
    Returns:
    
    the absolute URI corresponding to the the HTTP request
  - query
```
public String query()
```
    Specified by:
    
    query in interface HttpClientRequest
    
    Returns:
    
    the query part of the uri. For example someparam=32&someotherparam=x
  - path
```
public String path()
```
    Specified by:
    
    path in interface HttpClientRequest
    
    Returns:
    
    The path part of the uri. For example /somepath/somemorepath/someresource.foo
  - getURI
```
public String getURI()
```
    Specified by:
    
    getURI in interface HttpClientRequest
    
    Returns:
    
    The URI of the request.
  - setURI
```
public HttpClientRequest setURI(String uri)
```
    Description copied from interface: HttpClientRequest
    
    Set the request uri.
    
    Specified by:
    
    setURI in interface HttpClientRequest
    
    Parameters:
    
    uri - the request uri
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getHost
```
public String getHost()
```
    Specified by:
    
    getHost in interface HttpClientRequest
    
    Returns:
    
    the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header
  - setHost
```
public HttpClientRequest setHost(String host)
```
    Description copied from interface: HttpClientRequest
    
    Set the host value of the HTTP/1.1 host header or HTTP/2 authority pseudo header
    The initial value is the same than the server socket address host.
    Keep in mind that changing this value won't change the actual server socket address for this request.
    
    Specified by:
    
    setHost in interface HttpClientRequest
    
    Parameters:
    
    host - the host part of the HTTP/1.1 host header or HTTP/2 authority pseudo header
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPort
```
public int getPort()
```
    Specified by:
    
    getPort in interface HttpClientRequest
    
    Returns:
    
    the port value of the HTTP/1.1 host header or HTTP/2 authority pseudo header
  - setPort
```
public HttpClientRequest setPort(int port)
```
    Description copied from interface: HttpClientRequest
    
    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.
    
    Specified by:
    
    setPort in interface HttpClientRequest
    
    Parameters:
    
    port - the port part of the HTTP/1.1 host header or HTTP/2 authority pseudo header
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getMethod
```
public HttpMethod getMethod()
```
    Description copied from interface: HttpClientRequest
    
    The HTTP method for the request.
    
    Specified by:
    
    getMethod in interface HttpClientRequest
  - setMethod
```
public HttpClientRequest setMethod(HttpMethod method)
```
    Description copied from interface: HttpClientRequest
    
    Set the HTTP method for this request.
    
    Specified by:
    
    setMethod in interface HttpClientRequest
    
    Parameters:
    
    method - the HTTP method
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setTimeout
```
public HttpClientRequest setTimeout(long timeoutMs)
```
    Description copied from interface: HttpClientRequest
    
    Set's the amount of time after which if the request does not return any data within the timeout period an TimeoutException will be passed to the exception handler (if provided) and the request will be closed.
    Calling this method more than once has the effect of canceling any existing timeout and starting the timeout from scratch.
    
    Specified by:
    
    setTimeout in interface HttpClientRequest
    
    Parameters:
    
    timeoutMs - The quantity of time in milliseconds.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - reset
```
public boolean reset(long code)
```
    Description copied from interface: HttpClientRequest
    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.
    Specified by:
    
    reset in interface HttpClientRequest
    
    Parameters:
    
    code - the error code
    
    Returns:
    
    true when reset has been performed
  - reset
```
public boolean reset(long code,
                     Throwable cause)
```
    Description copied from interface: HttpClientRequest
    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.
    Specified by:
    
    reset in interface HttpClientRequest
    
    Parameters:
    
    code - the error code
    
    cause - an optional cause that can be attached to the error code
    
    Returns:
    
    true when reset has been performed
  - response
```
public HttpClientRequest response(Handler<AsyncResult<HttpClientResponse>> handler)
```
    Description copied from interface: HttpClientRequest
    
    Set a callback for the associated HttpClientResponse.
    This method does not modify the current request being sent.
    
    Specified by:
    
    response in interface HttpClientRequest
    
    Parameters:
    
    handler - the completion handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - response
```
public Future<HttpClientResponse> response()
```
    Specified by:
    
    response in interface HttpClientRequest
    
    Returns:
    
    a future of the HttpClientResponse, see HttpClientRequest.response(Handler)
  - pushHandler
```
public HttpClientRequest pushHandler(Handler<HttpClientRequest> handler)
```
    Description copied from interface: HttpClientRequest
    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.
    Specified by:
    
    pushHandler in interface HttpClientRequest
    
    Parameters:
    
    handler - the handler
    
    Returns:
    
    a reference to this, so the API can be used fluently

Class HttpClientRequestBase

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.core.http.HttpClientRequest

Methods inherited from interface io.vertx.core.streams.WriteStream

Field Detail

client

context

stream

server

ssl

Method Detail

authority

streamId

absoluteURI

query

path

getURI

setURI

getHost

setHost

getPort

setPort

getMethod

setMethod

setTimeout

reset

reset

response

response

pushHandler