Interface HttpClientResponse
-
- All Superinterfaces:
HttpResponseHead,ReadStream<Buffer>,StreamBase
public interface HttpClientResponse extends 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.- Author:
- Tim Fox
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Future<Buffer>body()Convenience method for receiving the entire request body in one piece.default HttpClientResponsebodyHandler(Handler<Buffer> bodyHandler)Convenience method for receiving the entire request body in one piece.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.HttpClientResponseexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.HttpClientResponsefetch(long amount)Fetch the specifiedamountof elements.StringgetTrailer(String trailerName)Return the first trailer value with the specified nameHttpClientResponsehandler(Handler<Buffer> handler)Set a data handler.NetSocketnetSocket()HttpClientResponsepause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.HttpClientRequestrequest()HttpClientResponseresume()Resume reading, and sets the buffer inflowingmode.HttpClientResponsestreamPriorityHandler(Handler<StreamPriority> handler)Set an handler for stream priority changes.MultiMaptrailers()-
Methods inherited from interface io.vertx.core.http.HttpResponseHead
cookies, getHeader, getHeader, headers, statusCode, statusMessage, version
-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
fetch
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
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
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
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
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
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
NetSocket netSocket()
- Returns:
- a
NetSocketfacade to interact with the HTTP client response.
-
getTrailer
String getTrailer(String trailerName)
Return the first trailer value with the specified name- Parameters:
trailerName- the trailer name- Returns:
- the trailer value
-
trailers
MultiMap trailers()
- Returns:
- the trailers
-
bodyHandler
default 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
-
body
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
-
end
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
-
customFrameHandler
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.- Returns:
- a reference to this, so the API can be used fluently
-
request
HttpClientRequest request()
- Returns:
- the corresponding request
-
streamPriorityHandler
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
-
-