Represents a client-side HTTP response.

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.

no subtypes hierarchy

Initializer
HttpClientResponse(HttpClientResponse unknown)
Inherited Attributes
Attributes inherited from: Object
hash, string
Methods
bodyHandlershared default HttpClientResponse bodyHandler(Anything(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

cookiesshared default List<String> cookies()
customFrameHandlershared default HttpClientResponse customFrameHandler(Anything(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.

endHandlershared actual default HttpClientResponse endHandler(Anything()? endHandler)

Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.

exceptionHandlershared actual default HttpClientResponse exceptionHandler(Anything(Throwable)? handler)

Set an exception handler.

getHeadershared default String? getHeader(String headerName)

Return the first header value with the specified name

Parameters:
  • headerName

    the header name

getTrailershared default String? getTrailer(String trailerName)

Return the first trailer value with the specified name

Parameters:
  • trailerName

    the trailer name

handlershared actual default HttpClientResponse handler(Anything(Buffer)? handler)

Set a data handler. As data is read, the handler will be called with the data.

headersshared default MultiMap headers()
netSocketshared default NetSocket netSocket()

Get a net socket for the underlying connection of this request.

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.

pauseshared actual default HttpClientResponse pause()

Pause the ReadSupport. While it's paused, no data will be sent to the dataHandler

requestshared default HttpClientRequest request()
resumeshared actual default HttpClientResponse resume()

Resume reading. If the ReadSupport has been paused, reading will recommence on it.

statusCodeshared default Integer statusCode()
statusMessageshared default String statusMessage()
trailersshared default MultiMap trailers()
versionshared default HttpVersion version()
Inherited Methods
Methods inherited from: Object
equals
Methods inherited from: ReadStream<T>
Methods inherited from: StreamBase