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.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<HttpClientResponse> |
__TYPE_ARG |
| Constructor and Description |
|---|
HttpClientResponse(HttpClientResponse delegate) |
HttpClientResponse(Object 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.
|
boolean |
equals(Object o) |
HttpClientResponse |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
HttpClientResponse |
fetch(long amount)
Fetch the specified
amount of elements. |
HttpClientResponse |
getDelegate() |
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.
|
int |
hashCode() |
MultiMap |
headers() |
NetSocket |
netSocket()
Get a net socket for the underlying connection of this request.
|
static HttpClientResponse |
newInstance(HttpClientResponse arg) |
HttpClientResponse |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
Pipe<Buffer> |
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .
|
void |
pipeTo(WriteStream<Buffer> dst)
Like
ReadStream.pipeTo(io.vertx.reactivex.core.streams.WriteStream<T>) but with no completion handler. |
void |
pipeTo(WriteStream<Buffer> dst,
Handler<AsyncResult<Void>> handler)
Pipe this
ReadStream to the WriteStream. |
HttpClientRequest |
request() |
HttpClientResponse |
resume()
Resume reading, and sets the buffer in
flowing mode. |
Completable |
rxPipeTo(WriteStream<Buffer> dst)
Pipe this
ReadStream to the WriteStream. |
int |
statusCode() |
String |
statusMessage() |
HttpClientResponse |
streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes.
|
Flowable<Buffer> |
toFlowable() |
Observable<Buffer> |
toObservable() |
String |
toString() |
MultiMap |
trailers() |
HttpVersion |
version() |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstance, newInstancenewInstancepublic static final io.vertx.lang.rx.TypeArg<HttpClientResponse> __TYPE_ARG
public HttpClientResponse(HttpClientResponse delegate)
public HttpClientResponse(Object delegate)
public HttpClientResponse getDelegate()
getDelegate in interface ReadStream<Buffer>getDelegate in interface StreamBasepublic Observable<Buffer> toObservable()
toObservable in interface ReadStream<Buffer>public Flowable<Buffer> toFlowable()
toFlowable in interface ReadStream<Buffer>public Pipe<Buffer> pipe()
WriteStream.pipe in interface ReadStream<Buffer>public void pipeTo(WriteStream<Buffer> dst)
ReadStream.pipeTo(io.vertx.reactivex.core.streams.WriteStream<T>) but with no completion handler.pipeTo in interface ReadStream<Buffer>dst - public void pipeTo(WriteStream<Buffer> dst, Handler<AsyncResult<Void>> handler)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
pipeTo in interface ReadStream<Buffer>dst - the destination write streamhandler - public Completable rxPipeTo(WriteStream<Buffer> dst)
ReadStream to the WriteStream.
Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be
called with the result.
dst - the destination write streampublic HttpClientResponse 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>public HttpClientResponse resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>public HttpClientResponse exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBasehandler - the exception handlerpublic HttpClientResponse handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>public 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>public HttpClientResponse endHandler(Handler<Void> endHandler)
ReadStreamendHandler 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.
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.
public HttpClientRequest request()
public HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler)
handler - the handler to be called when the stream priority changespublic String getHeader(CharSequence headerName)
headerName - the header namepublic static HttpClientResponse newInstance(HttpClientResponse arg)
Copyright © 2021 Eclipse. All rights reserved.