io.vertx.core.http

Interface HttpClientResponse

All Superinterfaces:

ReadStream<Buffer>, StreamBase

All Known Implementing Classes:

HttpClientResponseImpl

public interface HttpClientResponse
extends ReadStream<Buffer>

Represents a client-side HTTP response.<p> An instance is provided to the user via a Handler instance that was specified when one of the HTTP method operations, or the generic HttpClient#request(String, String, io.vertx.core.Handler) method was called on an instance of HttpClient.<p> It implements ReadStream so it can be used with Pump to pump data with flow control.<p> Instances of this class are not thread-safe.<p>

Author:

<a href="http://tfox.org">Tim Fox</a>

Method Summary

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	endHandler(Handler<Void> endHandler) Set an end handler.
HttpClientResponse	exceptionHandler(Handler<Throwable> handler) Set an exception handler.
HttpClientResponse	handler(Handler<Buffer> handler) Set a data handler.
MultiMap	headers()
NetSocket	netSocket() Get a net socket for the underlying connection of this request.
HttpClientResponse	pause() Pause the ReadSupport.
HttpClientResponse	resume() Resume reading.
int	statusCode() The HTTP status code of the response
String	statusMessage() The HTTP status message of the response
MultiMap	trailers()

Method Detail

resume

HttpClientResponse resume()

Description copied from interface: ReadStream

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

Specified by:

resume in interface ReadStream<Buffer>

exceptionHandler

HttpClientResponse exceptionHandler(Handler<Throwable> handler)

Description copied from interface: StreamBase

Set an exception handler.

Specified by:

exceptionHandler in interface ReadStream<Buffer>

Specified by:

exceptionHandler in interface StreamBase

handler

HttpClientResponse handler(Handler<Buffer> handler)

Description copied from interface: ReadStream

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

Specified by:

handler in interface ReadStream<Buffer>

pause

HttpClientResponse pause()

Description copied from interface: ReadStream

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

Specified by:

pause in interface ReadStream<Buffer>

endHandler

HttpClientResponse endHandler(Handler<Void> endHandler)

Description copied from interface: ReadStream

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

Specified by:

endHandler in interface ReadStream<Buffer>

statusCode

int statusCode()

The HTTP status code of the response

statusMessage

String statusMessage()

The HTTP status message of the response

headers

MultiMap headers()

Returns:

The HTTP headers

trailers

MultiMap trailers()

Returns:

The HTTP trailers

cookies

List<String> cookies()

Returns:

The Set-Cookie headers (including trailers)

bodyHandler

HttpClientResponse bodyHandler(Handler<Buffer> bodyHandler)

Convenience method for receiving the entire request body in one piece. This saves the user having to manually set a data and end handler 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

netSocket

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.

Returns:

the net socket