public class HttpClientResponse extends Object implements 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.
original
non RX-ified interface using Vert.x codegen.Constructor and Description |
---|
HttpClientResponse(HttpClientResponse delegate) |
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.
|
Object |
getDelegate() |
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.
|
static HttpClientResponse |
newInstance(HttpClientResponse arg) |
HttpClientResponse |
pause()
Pause the
ReadSupport . |
HttpClientResponse |
resume()
Resume reading.
|
int |
statusCode() |
String |
statusMessage() |
Observable<Buffer> |
toObservable() |
MultiMap |
trailers() |
HttpVersion |
version() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
newInstance
newInstance
public HttpClientResponse(HttpClientResponse delegate)
public Object getDelegate()
getDelegate
in interface ReadStream<Buffer>
getDelegate
in interface StreamBase
public Observable<Buffer> toObservable()
toObservable
in interface ReadStream<Buffer>
public HttpClientResponse resume()
ReadStream
ReadSupport
has been paused, reading will recommence on it.resume
in interface ReadStream<Buffer>
public HttpClientResponse exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Buffer>
exceptionHandler
in interface StreamBase
handler
- the exception handlerpublic HttpClientResponse handler(Handler<Buffer> handler)
ReadStream
handler
in interface ReadStream<Buffer>
public HttpClientResponse pause()
ReadStream
ReadSupport
. While it's paused, no data will be sent to the dataHandler
pause
in interface ReadStream<Buffer>
public HttpClientResponse endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Buffer>
public HttpVersion version()
public int statusCode()
public String statusMessage()
public MultiMap headers()
public String getHeader(String headerName)
headerName
- the header namepublic String getTrailer(String trailerName)
trailerName
- the trailer namepublic MultiMap trailers()
public 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 receivedpublic HttpClientResponse customFrameHandler(Handler<HttpFrame> handler)
handler
- public 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
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.
public static HttpClientResponse newInstance(HttpClientResponse arg)
Copyright © 2016. All rights reserved.