Class HttpClientResponse
- java.lang.Object
-
- io.vertx.reactivex.core.http.HttpClientResponse
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,HttpResponseHead,ReadStream<Buffer>,StreamBase
public class HttpClientResponse extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Buffer>, HttpResponseHead
Represents a client-side HTTP response.Vert.x provides you with one of these via the handler that was provided when creating the
HttpClientRequestor that was set on theHttpClientRequestinstance.It implements
ReadStreamso it can be used withPipeto pipe data with flow control.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<HttpClientResponse>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description HttpClientResponse(HttpClientResponse delegate)HttpClientResponse(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<Buffer>body()Convenience method for receiving the entire request body in one piece.HttpClientResponsebodyHandler(Handler<Buffer> bodyHandler)Convenience method for receiving the entire request body in one piece.List<String>cookies()HttpClientResponsecustomFrameHandler(Handler<HttpFrame> handler)Set an custom frame handler.Future<Void>end()Returns a future signaling when the response has been fully received successfully or failed.HttpClientResponseendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)HttpClientResponseexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.HttpClientResponsefetch(long amount)Fetch the specifiedamountof elements.HttpClientResponsegetDelegate()StringgetHeader(CharSequence headerName)Return the first header value with the specified nameStringgetHeader(String headerName)Return the first header value with the specified nameStringgetTrailer(String trailerName)Return the first trailer value with the specified nameHttpClientResponsehandler(Handler<Buffer> handler)Set a data handler.inthashCode()MultiMapheaders()NetSocketnetSocket()static HttpClientResponsenewInstance(HttpClientResponse arg)HttpClientResponsepause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<Buffer>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .Future<Void>pipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.HttpClientRequestrequest()HttpClientResponseresume()Resume reading, and sets the buffer inflowingmode.Single<Buffer>rxBody()Convenience method for receiving the entire request body in one piece.CompletablerxEnd()Returns a future signaling when the response has been fully received successfully or failed.CompletablerxPipeTo(WriteStream<Buffer> dst)Pipe thisReadStreamto theWriteStream.intstatusCode()StringstatusMessage()HttpClientResponsestreamPriorityHandler(Handler<StreamPriority> handler)Set an handler for stream priority changes.Flowable<Buffer>toFlowable()Observable<Buffer>toObservable()StringtoString()MultiMaptrailers()HttpVersionversion()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<HttpClientResponse> __TYPE_ARG
-
-
Constructor Detail
-
HttpClientResponse
public HttpClientResponse(HttpClientResponse delegate)
-
HttpClientResponse
public HttpClientResponse(Object delegate)
-
-
Method Detail
-
getDelegate
public HttpClientResponse getDelegate()
- Specified by:
getDelegatein interfaceHttpResponseHead- Specified by:
getDelegatein interfaceReadStream<Buffer>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<Buffer> toObservable()
- Specified by:
toObservablein interfaceReadStream<Buffer>
-
toFlowable
public Flowable<Buffer> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<Buffer>
-
version
public HttpVersion version()
- Specified by:
versionin interfaceHttpResponseHead- Returns:
- the version of the response
-
statusCode
public int statusCode()
- Specified by:
statusCodein interfaceHttpResponseHead- Returns:
- the status code of the response
-
statusMessage
public String statusMessage()
- Specified by:
statusMessagein interfaceHttpResponseHead- Returns:
- the status message of the response
-
headers
public MultiMap headers()
- Specified by:
headersin interfaceHttpResponseHead- Returns:
- the headers
-
getHeader
public String getHeader(String headerName)
Return the first header value with the specified name- Specified by:
getHeaderin interfaceHttpResponseHead- Parameters:
headerName- the header name- Returns:
- the header value
-
cookies
public List<String> cookies()
- Specified by:
cookiesin interfaceHttpResponseHead- Returns:
- the Set-Cookie headers (including trailers)
-
pipe
public Pipe<Buffer> pipe()
Pause this stream and return a to transfer the elements of this stream to a destination . The stream will be resumed when the pipe will be wired to aWriteStream.- Specified by:
pipein interfaceReadStream<Buffer>- Returns:
- a pipe
-
pipeTo
public Future<Void> pipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Buffer> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin interfaceReadStream<Buffer>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
fetch
public HttpClientResponse fetch(long amount)
Description copied from interface:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public HttpClientResponse resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
exceptionHandler
public HttpClientResponse exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<Buffer>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public HttpClientResponse handler(Handler<Buffer> handler)
Description copied from interface:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
pause
public HttpClientResponse pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public HttpClientResponse endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin interfaceReadStream<Buffer>- Returns:
- a reference to this, so the API can be used fluently
-
netSocket
public NetSocket netSocket()
- Returns:
- a
NetSocketfacade to interact with the HTTP client response.
-
getTrailer
public String getTrailer(String trailerName)
Return the first trailer value with the specified name- Parameters:
trailerName- the trailer name- Returns:
- the trailer value
-
trailers
public MultiMap trailers()
- Returns:
- the trailers
-
bodyHandler
public HttpClientResponse bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.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.
- Parameters:
bodyHandler- This handler will be called after all the body has been received- Returns:
-
body
public Future<Buffer> body()
Convenience method for receiving the entire request body in one piece.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.
- Returns:
- a future completed with the body result
-
rxBody
public Single<Buffer> rxBody()
Convenience method for receiving the entire request body in one piece.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.
- Returns:
- a future completed with the body result
-
end
public Future<Void> end()
Returns a future signaling when the response has been fully received successfully or failed.- Returns:
- a future completed with the body result
-
rxEnd
public Completable rxEnd()
Returns a future signaling when the response has been fully received successfully or failed.- Returns:
- a future completed with the body result
-
customFrameHandler
public HttpClientResponse customFrameHandler(Handler<HttpFrame> handler)
Set an custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.- Parameters:
handler-- Returns:
- a reference to this, so the API can be used fluently
-
request
public HttpClientRequest request()
- Returns:
- the corresponding request
-
streamPriorityHandler
public HttpClientResponse streamPriorityHandler(Handler<StreamPriority> handler)
Set an handler for stream priority changes. This is not implemented for HTTP/1.x.- Parameters:
handler- the handler to be called when the stream priority changes- Returns:
-
getHeader
public String getHeader(CharSequence headerName)
Return the first header value with the specified name- Parameters:
headerName- the header name- Returns:
- the header value
-
newInstance
public static HttpClientResponse newInstance(HttpClientResponse arg)
-
-