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.
Anything
HttpClientResponse
Basic
Identifiable
Object
Anything
no subtypes hierarchy
Initializer |
HttpClientResponse(HttpClientResponse unknown) |
Inherited Attributes |
Attributes inherited from: Object hash , string |
Methods | |
bodyHandler | shared 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:
|
cookies | shared default List<String> cookies() @return the Set-Cookie headers (including trailers) |
customFrameHandler | shared 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. |
endHandler | shared 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. Refines ReadStream.endHandler |
exceptionHandler | shared actual default HttpClientResponse exceptionHandler(Anything(Throwable)? handler) Set an exception handler. Refines StreamBase.exceptionHandler |
getHeader | shared default String? getHeader(String headerName) Return the first header value with the specified name Parameters:
|
getTrailer | shared default String? getTrailer(String trailerName) Return the first trailer value with the specified name Parameters:
|
handler | shared actual default HttpClientResponse handler(Anything(Buffer)? handler) Set a data handler. As data is read, the handler will be called with the data. Refines ReadStream.handler |
headers | shared default MultiMap headers() @return the headers |
netSocket | shared 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. |
pause | shared actual default HttpClientResponse pause() Pause the Refines ReadStream.pause |
resume | shared actual default HttpClientResponse resume() Resume reading. If the Refines ReadStream.resume |
statusCode | shared default Integer statusCode() @return the status code of the response |
statusMessage | shared default String statusMessage() @return the status message of the response |
trailers | shared default MultiMap trailers() @return the trailers |
version | shared default HttpVersion version() @return the version of the response |
Inherited Methods |
Methods inherited from: Object equals |
Methods inherited from: ReadStream<T> |
Methods inherited from: StreamBase |