public interface HttpClientResponse extends ReadStream<Buffer>
Vert.x provides you with one of these via the handler that was provided when creating the HttpClientRequest
or that was set on the HttpClientRequest instance.
It implements ReadStream so it can be used with
Pump to pump data with flow control.
| Modifier and Type | Method and Description |
|---|---|
HttpClientResponse |
bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.
|
List<String> |
cookies() |
HttpClientResponse |
customFrameHandler(Handler<HttpFrame> handler)
Set an custom frame handler.
|
HttpClientResponse |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
HttpClientResponse |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
HttpClientResponse |
fetch(long amount)
Fetch the specified
amount of elements. |
String |
getHeader(CharSequence headerName)
Return the first header value with the specified name
|
String |
getHeader(String headerName)
Return the first header value with the specified name
|
String |
getTrailer(String trailerName)
Return the first trailer value with the specified name
|
HttpClientResponse |
handler(Handler<Buffer> handler)
Set a data handler.
|
MultiMap |
headers() |
NetSocket |
netSocket()
Get a net socket for the underlying connection of this request.
|
HttpClientResponse |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
HttpClientRequest |
request() |
HttpClientResponse |
resume()
Resume reading, and sets the buffer in
flowing mode. |
int |
statusCode() |
String |
statusMessage() |
HttpClientResponse |
streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes.
|
MultiMap |
trailers() |
HttpVersion |
version() |
pipe, pipeTo, pipeToHttpClientResponse fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<Buffer>HttpClientResponse resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>HttpClientResponse exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBasehandler - the exception handlerHttpClientResponse handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>HttpClientResponse pause()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<Buffer>HttpClientResponse endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>HttpVersion version()
int statusCode()
String statusMessage()
MultiMap headers()
String getHeader(String headerName)
headerName - the header nameString getHeader(CharSequence headerName)
headerName - the header nameString getTrailer(String trailerName)
trailerName - the trailer nameMultiMap trailers()
HttpClientResponse bodyHandler(Handler<Buffer> bodyHandler)
This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.
bodyHandler - This handler will be called after all the body has been receivedHttpClientResponse customFrameHandler(Handler<HttpFrame> handler)
NetSocket netSocket()
USE THIS WITH CAUTION! Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol.
HTTP/1.1 pipe-lined requests cannot support net socket upgrade.
One valid use-case for calling this is to receive the NetSocket after a HTTP CONNECT was issued to the
remote peer and it responded with a status code of 200.
HttpClientRequest request()
HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler)
handler - the handler to be called when the stream priority changesCopyright © 2021 Eclipse. All rights reserved.